| GridFSDownloadStream Class |
Represents a Stream used by the application to read data from a GridFS file.
Inheritance HierarchyNamespace: MongoDB.Driver.GridFS
Assembly: MongoDB.Driver.GridFS (in MongoDB.Driver.GridFS.dll) Version: 2.1.0
SyntaxThe GridFSDownloadStream type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GridFSDownloadStream | Initializes a new instance of the GridFSDownloadStream class |
Methods| Name | Description | |
|---|---|---|
 | BeginRead | Begins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.) |
| BeginWrite | Begins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.) |
| Close | 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 Stream.) |
| CloseAsync |
Closes the GridFS stream.
|
| CopyTo(Stream) | Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.) |
| CopyTo(Stream, Int32) | Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.) |
| CopyToAsync(Stream) | Asynchronously reads the bytes from the current stream and writes them to another stream. (Inherited from Stream.) |
| CopyToAsync(Stream, Int32) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream.) |
| CopyToAsync(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 Stream.) |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| CreateWaitHandle | Obsolete. Allocates a WaitHandle object. (Inherited from Stream.) |
| Dispose | Releases all resources used by the Stream. (Inherited from Stream.) |
| Dispose(Boolean) | Releases the unmanaged resources used by the Stream and optionally releases the managed resources. (Inherited from Stream.) |
| EndRead | Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.) |
| EndWrite | Ends an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Inherited from Stream.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Flush | 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 Stream.) |
| FlushAsync | Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream.) |
| FlushAsync(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 Stream.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| ObjectInvariant | Obsolete. Provides support for a Contract. (Inherited from Stream.) |
| Read | 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 Stream.) |
| ReadAsync(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.) |
| ReadAsync(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 Stream.) |
| ReadByte | 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 Stream.) |
| Seek | When overridden in a derived class, sets the position within the current stream. (Inherited from Stream.) |
| SetLength | When overridden in a derived class, sets the length of the current stream. (Inherited from Stream.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Write | 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 Stream.) |
| WriteAsync(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.) |
| WriteAsync(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 Stream.) |
| WriteByte | Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
Properties| Name | Description | |
|---|---|---|
 | CanRead | When overridden in a derived class, gets a value indicating whether the current stream supports reading. (Inherited from Stream.) |
| CanSeek | When overridden in a derived class, gets a value indicating whether the current stream supports seeking. (Inherited from Stream.) |
| CanTimeout | Gets a value that determines whether the current stream can time out. (Inherited from Stream.) |
| CanWrite | When overridden in a derived class, gets a value indicating whether the current stream supports writing. (Inherited from Stream.) |
| FileInfo |
Gets the files collection document.
|
| Length | When overridden in a derived class, gets the length in bytes of the stream. (Inherited from Stream.) |
| Position | When overridden in a derived class, gets or sets the position within the current stream. (Inherited from Stream.) |
| ReadTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.) |
| WriteTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.) |
See Also