Click or drag to resize

ByteBufferStream Class

Represents a Stream backed by an IByteBuffer. Similar to MemoryStream but backed by an IByteBuffer instead of a byte array and also implements the BsonStream interface for higher performance BSON I/O.
Inheritance Hierarchy

Namespace:  MongoDB.Bson.IO
Assembly:  MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public class ByteBufferStream : BsonStream, 
	IStreamEfficientCopyTo

The ByteBufferStream type exposes the following members.

Constructors
  NameDescription
Public methodByteBufferStream
Initializes a new instance of the ByteBufferStream class.
Top
Properties
  NameDescription
Public propertyBuffer
Gets the buffer.
Public propertyCanRead
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
(Overrides StreamCanRead.)
Public propertyCanSeek
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
(Overrides StreamCanSeek.)
Public propertyCanTimeout
Gets a value that determines whether the current stream can time out.
(Overrides StreamCanTimeout.)
Public propertyCanWrite
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
(Overrides StreamCanWrite.)
Public propertyLength
When overridden in a derived class, gets the length in bytes of the stream.
(Overrides StreamLength.)
Public propertyPosition
When overridden in a derived class, gets or sets the position within the current stream.
(Overrides StreamPosition.)
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.
(Overrides StreamDispose(Boolean).)
Public methodEfficientCopyTo
Copy the current stream to the destination without making unnecessary copies of the bytes.
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.
(Overrides StreamFlush.)
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.
(Overrides StreamRead(Byte, Int32, Int32).)
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.
(Overrides StreamReadByte.)
Public methodReadCString
Reads a BSON CString from the stream.
(Overrides BsonStreamReadCString(UTF8Encoding).)
Public methodReadCStringBytes
Reads a BSON CString from the stream.
(Overrides BsonStreamReadCStringBytes.)
Public methodReadDecimal128
Reads a BSON Decimal128 from the stream.
(Overrides BsonStreamReadDecimal128.)
Public methodReadDouble
Reads a BSON double from the stream.
(Overrides BsonStreamReadDouble.)
Public methodReadInt32
Reads a 32-bit BSON integer from the stream.
(Overrides BsonStreamReadInt32.)
Public methodReadInt64
Reads a 64-bit BSON integer from the stream.
(Overrides BsonStreamReadInt64.)
Public methodReadObjectId
Reads a BSON ObjectId from the stream.
(Overrides BsonStreamReadObjectId.)
Public methodReadSlice
Reads a raw length prefixed slice from the stream.
(Overrides BsonStreamReadSlice.)
Public methodReadString
Reads a BSON string from the stream.
(Overrides BsonStreamReadString(UTF8Encoding).)
Public methodSeek
When overridden in a derived class, sets the position within the current stream.
(Overrides StreamSeek(Int64, SeekOrigin).)
Public methodSetLength
When overridden in a derived class, sets the length of the current stream.
(Overrides StreamSetLength(Int64).)
Public methodSkipCString
Skips over a BSON CString leaving the stream positioned just after the terminating null byte.
(Overrides BsonStreamSkipCString.)
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.
(Overrides StreamWrite(Byte, Int32, Int32).)
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.
(Overrides StreamWriteByte(Byte).)
Public methodWriteCString
Writes a BSON CString to the stream.
(Overrides BsonStreamWriteCString(String).)
Public methodWriteCStringBytes
Writes the CString bytes to the stream.
(Overrides BsonStreamWriteCStringBytes(Byte).)
Public methodWriteDecimal128
Writes a BSON Decimal128 to the stream.
(Overrides BsonStreamWriteDecimal128(Decimal128).)
Public methodWriteDouble
Writes a BSON double to the stream.
(Overrides BsonStreamWriteDouble(Double).)
Public methodWriteInt32
Writes a 32-bit BSON integer to the stream.
(Overrides BsonStreamWriteInt32(Int32).)
Public methodWriteInt64
Writes a 64-bit BSON integer to the stream.
(Overrides BsonStreamWriteInt64(Int64).)
Public methodWriteObjectId
Writes a BSON ObjectId to the stream.
(Overrides BsonStreamWriteObjectId(ObjectId).)
Public methodWriteString
Writes a BSON string to the stream.
(Overrides BsonStreamWriteString(String, UTF8Encoding).)
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