Class DateTimeSerializer

Namespace

MongoDB.Bson.Serialization.Serializers

Assembly

MongoDB.Bson.dll

Represents a serializer for DateTimes.

public class DateTimeSerializer : StructSerializerBase<DateTime>, IBsonSerializer<DateTime>, IBsonSerializer, IRepresentationConfigurable<DateTimeSerializer>, IRepresentationConfigurable, IHasRepresentationSerializer

Inheritance

object

SerializerBase<DateTime>

StructSerializerBase<DateTime>

DateTimeSerializer

Implements

IBsonSerializer<DateTime>

IBsonSerializer

IRepresentationConfigurable<DateTimeSerializer>

IRepresentationConfigurable

IHasRepresentationSerializer

Inherited Members

SerializerBase<DateTime>.ValueType

SerializerBase<DateTime>.CreateCannotBeDeserializedException()

SerializerBase<DateTime>.CreateCannotBeSerializedException()

SerializerBase<DateTime>.CreateCannotDeserializeFromBsonTypeException(BsonType)

SerializerBase<DateTime>.EnsureBsonTypeEquals(IBsonReader, BsonType)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

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

DateTimeSerializer()

Initializes a new instance of the DateTimeSerializer class.

public DateTimeSerializer()

DateTimeSerializer(BsonType)

Initializes a new instance of the DateTimeSerializer class.

public DateTimeSerializer(BsonType representation)

Parameters

representation BsonType

The representation.

DateTimeSerializer(bool)

Initializes a new instance of the DateTimeSerializer class.

public DateTimeSerializer(bool dateOnly)

Parameters

dateOnly bool

if set to true [date only].

DateTimeSerializer(bool, BsonType)

Initializes a new instance of the DateTimeSerializer class.

public DateTimeSerializer(bool dateOnly, BsonType representation)

Parameters

dateOnly bool

if set to true [date only].

representation BsonType

The representation.

DateTimeSerializer(DateTimeKind)

Initializes a new instance of the DateTimeSerializer class.

public DateTimeSerializer(DateTimeKind kind)

Parameters

kind DateTimeKind

The kind.

DateTimeSerializer(DateTimeKind, BsonType)

Initializes a new instance of the DateTimeSerializer class.

public DateTimeSerializer(DateTimeKind kind, BsonType representation)

Parameters

kind DateTimeKind

The kind.

representation BsonType

The representation.

Properties

DateOnly

Gets whether this DateTime consists of a Date only.

public bool DateOnly { get; }

Property Value

bool

DateOnlyInstance

Gets an instance of DateTimeSerializer with DateOnly=true.

public static DateTimeSerializer DateOnlyInstance { get; }

Property Value

DateTimeSerializer

Kind

Gets the DateTimeKind (Local, Unspecified or Utc).

public DateTimeKind Kind { get; }

Property Value

DateTimeKind

LocalInstance

Gets an instance of DateTimeSerializer with Kind=Local.

public static DateTimeSerializer LocalInstance { get; }

Property Value

DateTimeSerializer

Representation

Gets the external representation.

public BsonType Representation { get; }

Property Value

BsonType

The representation.

UtcInstance

Gets an instance of DateTimeSerializer with Kind=Utc.

public static DateTimeSerializer UtcInstance { get; }

Property Value

DateTimeSerializer

Methods

Deserialize(BsonDeserializationContext, BsonDeserializationArgs)

Deserializes a value.

public override DateTime Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)

Parameters

context BsonDeserializationContext

The deserialization context.

args BsonDeserializationArgs

The deserialization args.

Returns

DateTime

A deserialized value.

Serialize(BsonSerializationContext, BsonSerializationArgs, DateTime)

Serializes a value.

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

Parameters

context BsonSerializationContext

The serialization context.

args BsonSerializationArgs

The serialization args.

value DateTime

The object.

WithDateOnly(bool)

Returns a serializer that has been reconfigured with the specified dateOnly value.

public DateTimeSerializer WithDateOnly(bool dateOnly)

Parameters

dateOnly bool

if set to true the values will be required to be Date's only (zero time component).

Returns

DateTimeSerializer

The reconfigured serializer.

WithDateOnly(bool, BsonType)

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

public DateTimeSerializer WithDateOnly(bool dateOnly, BsonType representation)

Parameters

dateOnly bool

if set to true the values will be required to be Date's only (zero time component).

representation BsonType

The representation.

Returns

DateTimeSerializer

The reconfigured serializer.

WithKind(DateTimeKind)

Returns a serializer that has been reconfigured with the specified DateTimeKind value.

public DateTimeSerializer WithKind(DateTimeKind kind)

Parameters

kind DateTimeKind

The DateTimeKind.

Returns

DateTimeSerializer

The reconfigured serializer.

WithKind(DateTimeKind, BsonType)

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

public DateTimeSerializer WithKind(DateTimeKind kind, BsonType representation)

Parameters

kind DateTimeKind

The DateTimeKind.

representation BsonType

The representation.

Returns

DateTimeSerializer

The reconfigured serializer.

WithRepresentation(BsonType)

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

public DateTimeSerializer WithRepresentation(BsonType representation)

Parameters

representation BsonType

The representation.

Returns

DateTimeSerializer

The reconfigured serializer.