/* Copyright 2010-present MongoDB Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ using System; using System.IO; using MongoDB.Bson.IO; using MongoDB.Bson.Serialization.Attributes; using MongoDB.Bson.Serialization.Options; namespace MongoDB.Bson.Serialization.Serializers { /// /// Represents a serializer for Guids. /// public class GuidSerializer : StructSerializerBase, IRepresentationConfigurable { // private fields private readonly BsonType _representation; // constructors /// /// Initializes a new instance of the class. /// public GuidSerializer() : this(BsonType.Binary) { } /// /// Initializes a new instance of the class. /// /// The representation. public GuidSerializer(BsonType representation) { switch (representation) { case BsonType.Binary: case BsonType.String: break; default: var message = string.Format("{0} is not a valid representation for a GuidSerializer.", representation); throw new ArgumentException(message); } _representation = representation; } // public properties /// /// Gets the representation. /// /// /// The representation. /// public BsonType Representation { get { return _representation; } } // public methods /// /// Deserializes a value. /// /// The deserialization context. /// The deserialization args. /// A deserialized value. public override Guid Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args) { var bsonReader = context.Reader; string message; var bsonType = bsonReader.GetCurrentBsonType(); switch (bsonType) { case BsonType.Binary: var binaryData = bsonReader.ReadBinaryData(); var bytes = binaryData.Bytes; var subType = binaryData.SubType; var guidRepresentation = binaryData.GuidRepresentation; if (bytes.Length != 16) { message = string.Format("Expected length to be 16, not {0}.", bytes.Length); throw new FormatException(message); } if (subType != BsonBinarySubType.UuidStandard && subType != BsonBinarySubType.UuidLegacy) { message = string.Format("Expected binary sub type to be UuidStandard or UuidLegacy, not {0}.", subType); throw new FormatException(message); } if (guidRepresentation == GuidRepresentation.Unspecified) { throw new BsonSerializationException("GuidSerializer cannot deserialize a Guid when GuidRepresentation is Unspecified."); } return GuidConverter.FromBytes(bytes, guidRepresentation); case BsonType.String: return new Guid(bsonReader.ReadString()); default: throw CreateCannotDeserializeFromBsonTypeException(bsonType); } } /// /// Serializes a value. /// /// The serialization context. /// The serialization args. /// The object. public override void Serialize(BsonSerializationContext context, BsonSerializationArgs args, Guid value) { var bsonWriter = context.Writer; switch (_representation) { case BsonType.Binary: var writerGuidRepresentation = bsonWriter.Settings.GuidRepresentation; if (writerGuidRepresentation == GuidRepresentation.Unspecified) { throw new BsonSerializationException("GuidSerializer cannot serialize a Guid when GuidRepresentation is Unspecified."); } var bytes = GuidConverter.ToBytes(value, writerGuidRepresentation); var subType = (writerGuidRepresentation == GuidRepresentation.Standard) ? BsonBinarySubType.UuidStandard : BsonBinarySubType.UuidLegacy; bsonWriter.WriteBinaryData(new BsonBinaryData(bytes, subType, writerGuidRepresentation)); break; case BsonType.String: bsonWriter.WriteString(value.ToString()); break; default: var message = string.Format("'{0}' is not a valid Guid representation.", _representation); throw new BsonSerializationException(message); } } /// /// Returns a serializer that has been reconfigured with the specified representation. /// /// The representation. /// The reconfigured serializer. public GuidSerializer WithRepresentation(BsonType representation) { if (representation == _representation) { return this; } else { return new GuidSerializer(representation); } } // explicit interface implementations IBsonSerializer IRepresentationConfigurable.WithRepresentation(BsonType representation) { return WithRepresentation(representation); } } }