BsonStreamAdapter Class |
A Stream that wraps another Stream while implementing the BsonStream abstract methods.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.IOStream
MongoDB.Bson.IOBsonStream
MongoDB.Bson.IOBsonStreamAdapter
SystemMarshalByRefObject
System.IOStream
MongoDB.Bson.IOBsonStream
MongoDB.Bson.IOBsonStreamAdapter
Namespace: MongoDB.Bson.IO
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
SyntaxThe BsonStreamAdapter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BsonStreamAdapter |
Initializes a new instance of the BsonStreamAdapter class.
|
Properties| Name | Description | |
|---|---|---|
 | BaseStream |
Gets the base stream.
|
| CanRead | When overridden in a derived class, gets a value indicating whether the current stream supports reading. (Overrides StreamCanRead.) |
| CanSeek | When overridden in a derived class, gets a value indicating whether the current stream supports seeking. (Overrides StreamCanSeek.) |
| CanTimeout | Gets a value that determines whether the current stream can time out. (Overrides StreamCanTimeout.) |
| CanWrite | When overridden in a derived class, gets a value indicating whether the current stream supports writing. (Overrides StreamCanWrite.) |
| Length | When overridden in a derived class, gets the length in bytes of the stream. (Overrides StreamLength.) |
| Position | When overridden in a derived class, gets or sets the position within the current stream. (Overrides StreamPosition.) |
| ReadTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Overrides StreamReadTimeout.) |
| WriteTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Overrides StreamWriteTimeout.) |
Methods| Name | Description | |
|---|---|---|
| BeginRead | Begins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Overrides StreamBeginRead(Byte, Int32, Int32, AsyncCallback, Object).) |
| BeginWrite | Begins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Overrides StreamBeginWrite(Byte, Int32, Int32, AsyncCallback, Object).) |
| 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. (Overrides StreamClose.) |
| 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. (Overrides StreamCopyToAsync(Stream, Int32, CancellationToken).) |
| 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.) |
| Dispose | Releases all resources used by the Stream. (Inherited from Stream.) |
| EndRead | Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Overrides StreamEndRead(IAsyncResult).) |
| EndWrite | Ends an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead; see the Remarks section.) (Overrides StreamEndWrite(IAsyncResult).) |
| Equals | Determines whether the specified object is equal to the current object. (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. (Overrides StreamFlush.) |
| 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. (Overrides StreamFlushAsync(CancellationToken).) |
| 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.) |
| 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. (Overrides StreamRead(Byte, Int32, Int32).) |
| 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. (Overrides StreamReadAsync(Byte, Int32, Int32, CancellationToken).) |
| 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. (Overrides StreamReadByte.) |
| ReadCString |
Reads a BSON CString from the stream.
(Overrides BsonStreamReadCString(UTF8Encoding).) |
| ReadCStringBytes |
Reads a BSON CString from the stream.
(Overrides BsonStreamReadCStringBytes.) |
| ReadDecimal128 |
Reads a BSON Decimal128 from the stream.
(Overrides BsonStreamReadDecimal128.) |
| ReadDouble |
Reads a BSON double from the stream.
(Overrides BsonStreamReadDouble.) |
| ReadInt32 |
Reads a 32-bit BSON integer from the stream.
(Overrides BsonStreamReadInt32.) |
| ReadInt64 |
Reads a 64-bit BSON integer from the stream.
(Overrides BsonStreamReadInt64.) |
| ReadObjectId |
Reads a BSON ObjectId from the stream.
(Overrides BsonStreamReadObjectId.) |
| ReadSlice |
Reads a raw length prefixed slice from the stream.
(Overrides BsonStreamReadSlice.) |
| ReadString |
Reads a BSON string from the stream.
(Overrides BsonStreamReadString(UTF8Encoding).) |
| Seek | When overridden in a derived class, sets the position within the current stream. (Overrides StreamSeek(Int64, SeekOrigin).) |
| SetLength | When overridden in a derived class, sets the length of the current stream. (Overrides StreamSetLength(Int64).) |
| SkipCString |
Skips over a BSON CString leaving the stream positioned just after the terminating null byte.
(Overrides BsonStreamSkipCString.) |
| 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. (Overrides StreamWrite(Byte, Int32, Int32).) |
| 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. (Overrides StreamWriteAsync(Byte, Int32, Int32, CancellationToken).) |
| WriteByte | Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Overrides StreamWriteByte(Byte).) |
| WriteCString |
Writes a BSON CString to the stream.
(Overrides BsonStreamWriteCString(String).) |
| WriteCStringBytes |
Writes the CString bytes to the stream.
(Overrides BsonStreamWriteCStringBytes(Byte).) |
| WriteDecimal128 |
Writes a BSON Decimal128 to the stream.
(Overrides BsonStreamWriteDecimal128(Decimal128).) |
| WriteDouble |
Writes a BSON double to the stream.
(Overrides BsonStreamWriteDouble(Double).) |
| WriteInt32 |
Writes a 32-bit BSON integer to the stream.
(Overrides BsonStreamWriteInt32(Int32).) |
| WriteInt64 |
Writes a 64-bit BSON integer to the stream.
(Overrides BsonStreamWriteInt64(Int64).) |
| WriteObjectId |
Writes a BSON ObjectId to the stream.
(Overrides BsonStreamWriteObjectId(ObjectId).) |
| WriteString |
Writes a BSON string to the stream.
(Overrides BsonStreamWriteString(String, UTF8Encoding).) |
Extension Methods| Name | Description | |
|---|---|---|
 | BackpatchSize |
Backpatches the size.
(Defined by BsonStreamExtensions.) |
| ReadBinarySubType |
Reads the binary sub type.
(Defined by BsonStreamExtensions.) |
| ReadBoolean |
Reads a boolean from the stream.
(Defined by BsonStreamExtensions.) |
| ReadBsonType |
Reads the BSON type.
(Defined by BsonStreamExtensions.) |
| ReadBytes(Int32) | Overloaded.
Reads bytes from the stream.
(Defined by BsonStreamExtensions.) |
| ReadBytes(Byte, Int32, Int32) | Overloaded.
Reads bytes from the stream.
(Defined by BsonStreamExtensions.) |
| 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.) |
| WriteBinarySubType |
Writes a binary sub type to the stream.
(Defined by BsonStreamExtensions.) |
| WriteBoolean |
Writes a boolean to the stream.
(Defined by BsonStreamExtensions.) |
| WriteBsonType |
Writes a BsonType to the stream.
(Defined by BsonStreamExtensions.) |
| WriteBytes |
Writes bytes to the stream.
(Defined by BsonStreamExtensions.) |
| WriteSlice |
Writes a slice to the stream.
(Defined by BsonStreamExtensions.) |
See Also