21.52. Class IdSerializer
Namespace: ArmoniK.Core.Adapters.MongoDB.Table.DataModel.Auth
Assembly: ArmoniK.Core.Adapters.MongoDB.dll
Serializer class to/from Object to/from string
public class IdSerializer : SerializerBase<string>, IBsonSerializer<string>, IBsonSerializer
21.52.1. Inheritance
object ← SerializerBase<string> ← IdSerializer
21.52.2. Implements
IBsonSerializer<string>, IBsonSerializer
21.52.3. Inherited Members
SerializerBase<string>.Deserialize(BsonDeserializationContext, BsonDeserializationArgs), SerializerBase<string>.Serialize(BsonSerializationContext, BsonSerializationArgs, string), SerializerBase<string>.CreateCannotBeDeserializedException(), SerializerBase<string>.CreateCannotBeSerializedException(), SerializerBase<string>.CreateCannotDeserializeFromBsonTypeException(BsonType), SerializerBase<string>.EnsureBsonTypeEquals(IBsonReader, BsonType), SerializerBase<string>.ValueType, object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
21.52.4. Fields
21.52.4.1. Instance
Singleton instance of the serializer
public static readonly IdSerializer Instance
21.52.4.1.1. Field Value
21.52.5. Methods
21.52.5.1. Deserialize(BsonDeserializationContext, BsonDeserializationArgs)
Method used by the MongoDB driver to deserialize an ObjectID to string
public override string Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
21.52.5.1.1. Parameters
context BsonDeserializationContext
Deserialization context
args BsonDeserializationArgs
Deserialization arguments
21.52.5.1.2. Returns
ObjectID as a string
21.52.5.2. Deserialize(ObjectId)
Method to deserialize an objectId into a string
public static string Deserialize(ObjectId id)
21.52.5.2.1. Parameters
id ObjectId
The ObjectId
21.52.5.2.2. Returns
ObjectId as a string
21.52.5.3. Serialize(string)
Method to serialize an string into an ObjectId
public static ObjectId Serialize(string value)
21.52.5.3.1. Parameters
value string
the string, must be a 24 length hexstring
21.52.5.3.2. Returns
ObjectId
ObjectId
21.52.5.4. Serialize(BsonSerializationContext, BsonSerializationArgs, string)
Method used by the MongoDB driver to serialize a string to an ObjectID
public override void Serialize(BsonSerializationContext context, BsonSerializationArgs args, string value)
21.52.5.4.1. Parameters
context BsonSerializationContext
Serialization context
args BsonSerializationArgs
Serialization arguments
value string
String to serialize
21.52.5.5. ToValidIdString(string)
Converts any string to a valid hex string to be used as a MongoDB ID
public static string ToValidIdString(string value)
21.52.5.5.1. Parameters
value string
the string to convert
21.52.5.5.2. Returns
String as an ObjectId string