Class GridFSUploadStream

Namespace

MongoDB.Driver.GridFS

Assembly

MongoDB.Driver.GridFS.dll

Represents a Stream used by the application to write data to a GridFS file.

public class GridFSUploadStream : DelegatingStream, IDisposable

Inheritance

object

MarshalByRefObject

Stream

DelegatingStream

GridFSUploadStream

Implements

IDisposable

Inherited Members

DelegatingStream.CanRead

DelegatingStream.CanSeek

DelegatingStream.CanTimeout

DelegatingStream.CanWrite

DelegatingStream.Length

DelegatingStream.Position

DelegatingStream.ReadTimeout

DelegatingStream.WriteTimeout

DelegatingStream.BeginRead(byte[], int, int, AsyncCallback, object)

DelegatingStream.BeginWrite(byte[], int, int, AsyncCallback, object)

DelegatingStream.Close()

DelegatingStream.CopyToAsync(Stream, int, CancellationToken)

DelegatingStream.CreateWaitHandle()

DelegatingStream.Dispose(bool)

DelegatingStream.EndRead(IAsyncResult)

DelegatingStream.EndWrite(IAsyncResult)

DelegatingStream.Equals(object)

DelegatingStream.Flush()

DelegatingStream.FlushAsync(CancellationToken)

DelegatingStream.GetHashCode()

DelegatingStream.Read(byte[], int, int)

DelegatingStream.ReadAsync(byte[], int, int, CancellationToken)

DelegatingStream.ReadByte()

DelegatingStream.Seek(long, SeekOrigin)

DelegatingStream.SetLength(long)

DelegatingStream.ToString()

DelegatingStream.Write(byte[], int, int)

DelegatingStream.WriteAsync(byte[], int, int, CancellationToken)

DelegatingStream.WriteByte(byte)

Stream.Null

Stream.CopyTo(Stream)

Stream.CopyTo(Stream, int)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.Dispose()

Stream.FlushAsync()

Stream.ObjectInvariant()

Stream.ReadAsync(byte[], int, int)

Stream.Synchronized(Stream)

Stream.WriteAsync(byte[], int, int)

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

Id

Gets the id of the file being added to GridFS.

public ObjectId Id { get; }

Property Value

ObjectId

The id of the file being added to GridFS.

Methods

Abort(CancellationToken)

Aborts an upload operation.

public void Abort(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Remarks

Any partial results already written to the server are deleted when Abort is called.

AbortAsync(CancellationToken)

Aborts an upload operation.

public Task AbortAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A Task.

Remarks

Any partial results already written to the server are deleted when AbortAsync is called.

Close(CancellationToken)

Closes the Stream and completes the upload operation.

public void Close(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Remarks

Any data remaining in the Stream is flushed to the server and the GridFS files collection document is written.

CloseAsync(CancellationToken)

Closes the Stream and completes the upload operation.

public Task CloseAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A Task.

Remarks

Any data remaining in the Stream is flushed to the server and the GridFS files collection document is written.