Class BsonExtensionMethods

Namespace

MongoDB.Bson

Assembly

MongoDB.Bson.dll

A static class containing BSON extension methods.

public static class BsonExtensionMethods

Inheritance

object

BsonExtensionMethods

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

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

Serializes an object to a BSON byte array.

public static byte[] ToBson(this object obj, Type nominalType, BsonBinaryWriterSettings writerSettings = null, IBsonSerializer serializer = null, Action<BsonSerializationContext.Builder> configurator = null, BsonSerializationArgs args = default, int estimatedBsonSize = 0)

Parameters

obj object

The object.

nominalType Type

The nominal type of the object..

writerSettings BsonBinaryWriterSettings

The writer settings.

serializer IBsonSerializer

The serializer.

configurator Action<BsonSerializationContext.Builder>

The serialization context configurator.

args BsonSerializationArgs

The serialization args.

estimatedBsonSize int

The estimated size of the serialized object.

Returns

byte[]

A BSON byte array.

Exceptions

ArgumentNullException

nominalType

ArgumentException

serializer

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

Serializes an object to a BsonDocument.

public static BsonDocument ToBsonDocument(this object obj, Type nominalType, IBsonSerializer serializer = null, Action<BsonSerializationContext.Builder> configurator = null, BsonSerializationArgs args = default)

Parameters

obj object

The object.

nominalType Type

The nominal type of the object.

serializer IBsonSerializer

The serializer.

configurator Action<BsonSerializationContext.Builder>

The serialization context configurator.

args BsonSerializationArgs

The serialization args.

Returns

BsonDocument

A BsonDocument.

Exceptions

ArgumentNullException

nominalType

ArgumentException

serializer

ToBsonDocument<TNominalType>(TNominalType, IBsonSerializer<TNominalType>, Action<Builder>, BsonSerializationArgs)

Serializes an object to a BsonDocument.

public static BsonDocument ToBsonDocument<TNominalType>(this TNominalType obj, IBsonSerializer<TNominalType> serializer = null, Action<BsonSerializationContext.Builder> configurator = null, BsonSerializationArgs args = default)

Parameters

obj TNominalType

The object.

serializer IBsonSerializer<TNominalType>

The serializer.

configurator Action<BsonSerializationContext.Builder>

The serialization context configurator.

args BsonSerializationArgs

The serialization args.

Returns

BsonDocument

A BsonDocument.

Type Parameters

TNominalType

The nominal type of the object.

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

Serializes an object to a BSON byte array.

public static byte[] ToBson<TNominalType>(this TNominalType obj, IBsonSerializer<TNominalType> serializer = null, BsonBinaryWriterSettings writerSettings = null, Action<BsonSerializationContext.Builder> configurator = null, BsonSerializationArgs args = default, int estimatedBsonSize = 0)

Parameters

obj TNominalType

The object.

serializer IBsonSerializer<TNominalType>

The serializer.

writerSettings BsonBinaryWriterSettings

The writer settings.

configurator Action<BsonSerializationContext.Builder>

The serialization context configurator.

args BsonSerializationArgs

The serialization args.

estimatedBsonSize int

The estimated size of the serialized object

Returns

byte[]

A BSON byte array.

Type Parameters

TNominalType

The nominal type of the object.

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

Serializes an object to a JSON string.

public static string ToJson(this object obj, Type nominalType, JsonWriterSettings writerSettings = null, IBsonSerializer serializer = null, Action<BsonSerializationContext.Builder> configurator = null, BsonSerializationArgs args = default)

Parameters

obj object

The object.

nominalType Type

The nominal type of the objectt.

writerSettings JsonWriterSettings

The JsonWriter settings.

serializer IBsonSerializer

The serializer.

configurator Action<BsonSerializationContext.Builder>

The serialization context configurator.

args BsonSerializationArgs

The serialization args.

Returns

string

A JSON string.

Exceptions

ArgumentNullException

nominalType

ArgumentException

serializer

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

Serializes an object to a JSON string.

public static string ToJson<TNominalType>(this TNominalType obj, JsonWriterSettings writerSettings = null, IBsonSerializer<TNominalType> serializer = null, Action<BsonSerializationContext.Builder> configurator = null, BsonSerializationArgs args = default)

Parameters

obj TNominalType

The object.

writerSettings JsonWriterSettings

The JsonWriter settings.

serializer IBsonSerializer<TNominalType>

The serializer.

configurator Action<BsonSerializationContext.Builder>

The serialization context configurator.

args BsonSerializationArgs

The serialization args.

Returns

string

A JSON string.

Type Parameters

TNominalType

The nominal type of the object.