Class EnumSerializer<TEnum>

Namespace

MongoDB.Bson.Serialization.Serializers

Assembly

MongoDB.Bson.dll

Represents a serializer for enums.

public class EnumSerializer<TEnum> : StructSerializerBase<TEnum>, IBsonSerializer<TEnum>, IBsonSerializer, IRepresentationConfigurable<EnumSerializer<TEnum>>, IRepresentationConfigurable, IHasRepresentationSerializer where TEnum : struct, Enum

Type Parameters

TEnum

The type of the enum.

Inheritance

object

SerializerBase<TEnum>

StructSerializerBase<TEnum>

EnumSerializer<TEnum>

Implements

IBsonSerializer<TEnum>

IBsonSerializer

IRepresentationConfigurable<EnumSerializer<TEnum>>

IRepresentationConfigurable

IHasRepresentationSerializer

Inherited Members

SerializerBase<TEnum>.ValueType

SerializerBase<TEnum>.CreateCannotBeDeserializedException()

SerializerBase<TEnum>.CreateCannotBeSerializedException()

SerializerBase<TEnum>.CreateCannotDeserializeFromBsonTypeException(BsonType)

SerializerBase<TEnum>.EnsureBsonTypeEquals(IBsonReader, BsonType)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IBsonSerializerExtensions.Deserialize(IBsonSerializer, BsonDeserializationContext)

IBsonSerializerExtensions.Serialize(IBsonSerializer, BsonSerializationContext, object)

IBsonSerializerExtensions.ToBsonValue(IBsonSerializer, object)

IBsonSerializerExtensions.Deserialize<TValue>(IBsonSerializer<TValue>, BsonDeserializationContext)

IBsonSerializerExtensions.Serialize<TValue>(IBsonSerializer<TValue>, BsonSerializationContext, TValue)

IBsonSerializerExtensions.ToBsonValue<TValue>(IBsonSerializer<TValue>, TValue)

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)

Constructors

EnumSerializer()

Initializes a new instance of the EnumSerializer<TEnum> class.

public EnumSerializer()

EnumSerializer(BsonType)

Initializes a new instance of the EnumSerializer<TEnum> class.

public EnumSerializer(BsonType representation)

Parameters

representation BsonType

The representation.

Properties

Representation

Gets the representation.

public BsonType Representation { get; }

Property Value

BsonType

The representation.

Methods

Deserialize(BsonDeserializationContext, BsonDeserializationArgs)

Deserializes a value.

public override TEnum Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)

Parameters

context BsonDeserializationContext

The deserialization context.

args BsonDeserializationArgs

The deserialization args.

Returns

TEnum

A deserialized value.

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Serialize(BsonSerializationContext, BsonSerializationArgs, TEnum)

Serializes a value.

public override void Serialize(BsonSerializationContext context, BsonSerializationArgs args, TEnum value)

Parameters

context BsonSerializationContext

The serialization context.

args BsonSerializationArgs

The serialization args.

value TEnum

The object.

WithRepresentation(BsonType)

Returns a serializer that has been reconfigured with the specified representation.

public EnumSerializer<TEnum> WithRepresentation(BsonType representation)

Parameters

representation BsonType

The representation.

Returns

EnumSerializer<TEnum>

The reconfigured serializer.