Click or drag to resize

BsonStream Class

Represents a Stream has additional methods to suport reading and writing BSON values.
Inheritance Hierarchy

Namespace:  MongoDB.Bson.IO
Assembly:  MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.9.0+32b058abcdf2c7e8d9dd3a676d207b31897eee2e
Syntax
public abstract class BsonStream : Stream

The BsonStream type exposes the following members.

Constructors
  NameDescription
Protected methodBsonStream
Initializes a new instance of the BsonStream class
Top
Properties
  NameDescription
Public propertyCanRead
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
(Inherited from Stream.)
Public propertyCanSeek
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
(Inherited from Stream.)
Public propertyCanTimeout
Gets a value that determines whether the current stream can time out.
(Inherited from Stream.)
Public propertyCanWrite
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
(Inherited from Stream.)
Public propertyLength
When overridden in a derived class, gets the length in bytes of the stream.
(Inherited from Stream.)
Public propertyPosition
When overridden in a derived class, gets or sets the position within the current stream.
(Inherited from Stream.)
Public propertyReadTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream.)
Public propertyWriteTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream.)
Top
Methods
  NameDescription
Public methodBeginRead (Inherited from Stream.)
Public methodBeginWrite (Inherited from Stream.)
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 Stream.)
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 Stream.)
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 MarshalByRefObject.)
Protected methodCreateWaitHandle Obsolete.
Allocates a WaitHandle object.
(Inherited from Stream.)
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 Stream.)
Public methodEndRead (Inherited from Stream.)
Public methodEndWrite (Inherited from Stream.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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 Stream.)
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 Stream.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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 MarshalByRefObject.)
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 Stream.)
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 Stream.)
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 Stream.)
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 Stream.)
Public methodReadCString
Reads a BSON CString from the stream.
Public methodReadCStringBytes
Reads a BSON CString from the stream.
Public methodReadDecimal128
Reads a BSON Decimal128 from the stream.
Public methodReadDouble
Reads a BSON double from the stream.
Public methodReadInt32
Reads a 32-bit BSON integer from the stream.
Public methodReadInt64
Reads a 64-bit BSON integer from the stream.
Public methodReadObjectId
Reads a BSON ObjectId from the stream.
Public methodReadSlice
Reads a raw length prefixed slice from the stream.
Public methodReadString
Reads a BSON string from the stream.
Public methodSeek
When overridden in a derived class, sets the position within the current stream.
(Inherited from Stream.)
Public methodSetLength
When overridden in a derived class, sets the length of the current stream.
(Inherited from Stream.)
Public methodSkipCString
Skips over a BSON CString leaving the stream positioned just after the terminating null byte.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
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 Stream.)
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 Stream.)
Public methodWriteByte
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from Stream.)
Public methodWriteCString
Writes a BSON CString to the stream.
Public methodWriteCStringBytes
Writes the CString bytes to the stream.
Public methodWriteDecimal128
Writes a BSON Decimal128 to the stream.
Public methodWriteDouble
Writes a BSON double to the stream.
Public methodWriteInt32
Writes a 32-bit BSON integer to the stream.
Public methodWriteInt64
Writes a 64-bit BSON integer to the stream.
Public methodWriteObjectId
Writes a BSON ObjectId to the stream.
Public methodWriteString
Writes a BSON string to the stream.
Top
Extension Methods
  NameDescription
Public Extension MethodBackpatchSize
Backpatches the size.
(Defined by BsonStreamExtensions.)
Public Extension MethodReadBinarySubType
Reads the binary sub type.
(Defined by BsonStreamExtensions.)
Public Extension MethodReadBoolean
Reads a boolean from the stream.
(Defined by BsonStreamExtensions.)
Public Extension MethodReadBsonType
Reads the BSON type.
(Defined by BsonStreamExtensions.)
Public Extension MethodReadBytes(Int32)Overloaded.
Reads bytes from the stream.
(Defined by BsonStreamExtensions.)
Public Extension MethodReadBytes(Byte, Int32, Int32)Overloaded.
Reads bytes from the stream.
(Defined by BsonStreamExtensions.)
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.)
Public Extension MethodWriteBinarySubType
Writes a binary sub type to the stream.
(Defined by BsonStreamExtensions.)
Public Extension MethodWriteBoolean
Writes a boolean to the stream.
(Defined by BsonStreamExtensions.)
Public Extension MethodWriteBsonType
Writes a BsonType to the stream.
(Defined by BsonStreamExtensions.)
Public Extension MethodWriteBytes
Writes bytes to the stream.
(Defined by BsonStreamExtensions.)
Public Extension MethodWriteSlice
Writes a slice to the stream.
(Defined by BsonStreamExtensions.)
Top
See Also