Interface IByteBuffer

Namespace

MongoDB.Bson.IO

Assembly

MongoDB.Bson.dll

Represents a byte buffer (backed by various means depending on the implementation).

public interface IByteBuffer : IDisposable

Inherited Members

IDisposable.Dispose()

Extension Methods

BsonExtensionMethods.ToBsonDocument<TNominalType>(TNominalType, IBsonSerializer<TNominalType>, Action<BsonSerializationContext.Builder>, BsonSerializationArgs)

BsonExtensionMethods.ToBson<TNominalType>(TNominalType, IBsonSerializer<TNominalType>, BsonBinaryWriterSettings, Action<BsonSerializationContext.Builder>, BsonSerializationArgs, int)

BsonExtensionMethods.ToJson<TNominalType>(TNominalType, JsonWriterSettings, IBsonSerializer<TNominalType>, Action<BsonSerializationContext.Builder>, BsonSerializationArgs)

BsonExtensionMethods.ToBson(object, Type, BsonBinaryWriterSettings, IBsonSerializer, Action<BsonSerializationContext.Builder>, BsonSerializationArgs, int)

BsonExtensionMethods.ToBsonDocument(object, Type, IBsonSerializer, Action<BsonSerializationContext.Builder>, BsonSerializationArgs)

BsonExtensionMethods.ToJson(object, Type, JsonWriterSettings, IBsonSerializer, Action<BsonSerializationContext.Builder>, BsonSerializationArgs)

Properties

Capacity

Gets the capacity.

int Capacity { get; }

Property Value

int

The capacity.

IsReadOnly

Gets a value indicating whether this instance is read only.

bool IsReadOnly { get; }

Property Value

bool

true if this instance is read only; otherwise, false.

Length

Gets or sets the length.

int Length { get; set; }

Property Value

int

The length.

Methods

AccessBackingBytes(int)

Access the backing bytes directly. The returned ArraySegment will point to the desired position and contain as many bytes as possible up to the next chunk boundary (if any). If the returned ArraySegment does not contain enough bytes for your needs you will have to call ReadBytes instead.

ArraySegment<byte> AccessBackingBytes(int position)

Parameters

position int

The position.

Returns

ArraySegment<byte>

An ArraySegment pointing directly to the backing bytes for the position.

Clear(int, int)

Clears the specified bytes.

void Clear(int position, int count)

Parameters

position int

The position.

count int

The count.

EnsureCapacity(int)

Ensure that the buffer has a minimum capacity. Depending on the buffer allocation strategy calling this method may result in a higher capacity than the minimum (but never lower).

void EnsureCapacity(int minimumCapacity)

Parameters

minimumCapacity int

The minimum capacity.

GetByte(int)

Gets a byte.

byte GetByte(int position)

Parameters

position int

The position.

Returns

byte

A byte.

GetBytes(int, byte[], int, int)

Gets bytes.

void GetBytes(int position, byte[] destination, int offset, int count)

Parameters

position int

The position.

destination byte[]

The destination.

offset int

The destination offset.

count int

The count.

GetSlice(int, int)

Gets a slice of this buffer.

IByteBuffer GetSlice(int position, int length)

Parameters

position int

The position of the start of the slice.

length int

The length of the slice.

Returns

IByteBuffer

A slice of this buffer.

MakeReadOnly()

Makes this buffer read only.

void MakeReadOnly()

SetByte(int, byte)

Sets a byte.

void SetByte(int position, byte value)

Parameters

position int

The position.

value byte

The value.

SetBytes(int, byte[], int, int)

Sets bytes.

void SetBytes(int position, byte[] source, int offset, int count)

Parameters

position int

The position.

source byte[]

The bytes.

offset int

The offset.

count int

The count.