Click or drag to resize

GridFSUploadStream Class

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

Namespace:  MongoDB.Driver.GridFS
Assembly:  MongoDB.Driver.GridFS (in MongoDB.Driver.GridFS.dll) Version: 2.7.3+Branch.v2.7.x.Sha.2f1f2be13a23b8520cb9c2ee8439c022f9a03efe
Syntax
public class GridFSUploadStream : DelegatingStream

The GridFSUploadStream type exposes the following members.

Properties
  NameDescription
Public propertyCanRead
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
(Inherited from DelegatingStream.)
Public propertyCanSeek
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
(Inherited from DelegatingStream.)
Public propertyCanTimeout
Gets a value that determines whether the current stream can time out.
(Inherited from DelegatingStream.)
Public propertyCanWrite
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
(Inherited from DelegatingStream.)
Public propertyId
Gets the id of the file being added to GridFS.
Public propertyLength
When overridden in a derived class, gets the length in bytes of the stream.
(Inherited from DelegatingStream.)
Public propertyPosition
When overridden in a derived class, gets or sets the position within the current stream.
(Inherited from DelegatingStream.)
Public propertyReadTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from DelegatingStream.)
Public propertyWriteTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from DelegatingStream.)
Top
Methods
  NameDescription
Public methodAbort
Aborts an upload operation.
Public methodAbortAsync
Aborts an upload operation.
Public methodBeginRead (Inherited from DelegatingStream.)
Public methodBeginWrite (Inherited from DelegatingStream.)
Public methodClose
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.
(Inherited from DelegatingStream.)
Public methodClose(CancellationToken)
Closes the Stream and completes the upload operation.
Public methodCloseAsync
Closes the Stream and completes the upload operation.
Public methodCopyTo(Stream)
Reads the bytes from the current stream and writes them to another stream.
(Inherited from Stream.)
Public methodCopyTo(Stream, Int32)
Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from Stream.)
Public methodCopyToAsync(Stream)
Asynchronously reads the bytes from the current stream and writes them to another stream.
(Inherited from Stream.)
Public methodCopyToAsync(Stream, Int32)
Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from Stream.)
Public methodCopyToAsync(Stream, Int32, CancellationToken)
Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.
(Inherited from DelegatingStream.)
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from DelegatingStream.)
Protected methodCreateWaitHandle Obsolete.
Allocates a WaitHandle object.
(Inherited from DelegatingStream.)
Public methodDispose
Releases all resources used by the Stream.
(Inherited from Stream.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
(Inherited from DelegatingStream.)
Public methodEndRead (Inherited from DelegatingStream.)
Public methodEndWrite (Inherited from DelegatingStream.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from DelegatingStream.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFlush
When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Inherited from DelegatingStream.)
Public methodFlushAsync
Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Inherited from Stream.)
Public methodFlushAsync(CancellationToken)
Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
(Inherited from DelegatingStream.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from DelegatingStream.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from DelegatingStream.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodObjectInvariant Obsolete.
Provides support for a Contract.
(Inherited from DelegatingStream.)
Public methodRead
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Inherited from DelegatingStream.)
Public methodReadAsync(Byte, Int32, Int32)
Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Inherited from Stream.)
Public methodReadAsync(Byte, Int32, Int32, CancellationToken)
Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
(Inherited from DelegatingStream.)
Public methodReadByte
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
(Inherited from DelegatingStream.)
Public methodSeek
When overridden in a derived class, sets the position within the current stream.
(Inherited from DelegatingStream.)
Public methodSetLength
When overridden in a derived class, sets the length of the current stream.
(Inherited from DelegatingStream.)
Public methodToString
Returns a string that represents the current object.
(Inherited from DelegatingStream.)
Public methodWrite
When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
(Inherited from DelegatingStream.)
Public methodWriteAsync(Byte, Int32, Int32)
Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
(Inherited from Stream.)
Public methodWriteAsync(Byte, Int32, Int32, CancellationToken)
Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
(Inherited from DelegatingStream.)
Public methodWriteByte
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from DelegatingStream.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also