17.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
17.52.1. Inheritance
object ← SerializerBase<string> ← IdSerializer
17.52.2. Implements
IBsonSerializer<string>, IBsonSerializer
17.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()
17.52.4. Fields
17.52.4.1. Instance
Singleton instance of the serializer
public static readonly IdSerializer Instance
17.52.4.1.1. Field Value
17.52.5. Methods
17.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)
17.52.5.1.1. Parameters
context BsonDeserializationContext
Deserialization context
args BsonDeserializationArgs
Deserialization arguments
17.52.5.1.2. Returns
ObjectID as a string
17.52.5.2. Deserialize(ObjectId)
Method to deserialize an objectId into a string
public static string Deserialize(ObjectId id)
17.52.5.2.1. Parameters
id ObjectId
The ObjectId
17.52.5.2.2. Returns
ObjectId as a string
17.52.5.3. Serialize(string)
Method to serialize an string into an ObjectId
public static ObjectId Serialize(string value)
17.52.5.3.1. Parameters
value string
the string, must be a 24 length hexstring
17.52.5.3.2. Returns
ObjectId
ObjectId
17.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)
17.52.5.4.1. Parameters
context BsonSerializationContext
Serialization context
args BsonSerializationArgs
Serialization arguments
value string
String to serialize
17.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)
17.52.5.5.1. Parameters
value string
the string to convert
17.52.5.5.2. Returns
String as an ObjectId string