105 lines
5.1 KiB
C#
105 lines
5.1 KiB
C#
// This file is part of YamlDotNet - A .NET library for YAML.
|
|
// Copyright (c) Antoine Aubry and contributors
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
// this software and associated documentation files (the "Software"), to deal in
|
|
// the Software without restriction, including without limitation the rights to
|
|
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
// of the Software, and to permit persons to whom the Software is furnished to do
|
|
// so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in all
|
|
// copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
// SOFTWARE.
|
|
|
|
using System;
|
|
using System.Globalization;
|
|
using System.Linq;
|
|
using YamlDotNet.Core;
|
|
using YamlDotNet.Core.Events;
|
|
|
|
namespace YamlDotNet.Serialization.Converters
|
|
{
|
|
/// <summary>
|
|
/// Converts the <seealso cref="DateTimeOffset"/> object to a string representation
|
|
/// To use this converter, call WithTypeConverter(new DateTimeOffsetConverter()) on the
|
|
/// <seealso cref="DeserializerBuilder"/> or <seealso cref="SerializerBuilder"/>.
|
|
/// </summary>
|
|
public class DateTimeOffsetConverter : IYamlTypeConverter
|
|
{
|
|
private readonly IFormatProvider provider;
|
|
private readonly ScalarStyle style;
|
|
private readonly DateTimeStyles dateStyle;
|
|
private readonly string[] formats;
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="DateTimeOffsetConverter"/> class.
|
|
/// </summary>
|
|
/// <param name="provider"><see cref="IFormatProvider"/> instance. Default value is <see cref="CultureInfo.InvariantCulture"/>.</param>
|
|
/// <param name="style">If true, will use double quotes when writing the value to the stream.</param>
|
|
/// <param name="dateStyle"></param>
|
|
/// <param name="formats">List of date/time formats for parsing. Default value is "<c>O</c>".</param>
|
|
/// <remarks>On deserializing, all formats in the list are used for conversion, while on serializing, the first format in the list is used.</remarks>
|
|
public DateTimeOffsetConverter(
|
|
IFormatProvider? provider = null,
|
|
ScalarStyle style = ScalarStyle.Any,
|
|
DateTimeStyles dateStyle = DateTimeStyles.None,
|
|
params string[] formats)
|
|
{
|
|
this.provider = provider ?? CultureInfo.InvariantCulture;
|
|
this.style = style;
|
|
this.dateStyle = dateStyle;
|
|
this.formats = formats.DefaultIfEmpty("O").ToArray();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the current converter supports converting the specified type.
|
|
/// </summary>
|
|
/// <param name="type"><see cref="Type"/> to check.</param>
|
|
/// <returns>Returns <c>True</c>, if the current converter supports; otherwise returns <c>False</c>.</returns>
|
|
public bool Accepts(Type type)
|
|
{
|
|
return type == typeof(DateTimeOffset);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Reads an object's state from a YAML parser.
|
|
/// </summary>
|
|
/// <param name="parser"><see cref="IParser"/> instance.</param>
|
|
/// <param name="type"><see cref="Type"/> to convert.</param>
|
|
/// <param name="rootDeserializer">The deserializer to use to deserialize complex types.</param>
|
|
/// <returns>Returns the <see cref="DateTime"/> instance converted.</returns>
|
|
/// <remarks>On deserializing, all formats in the list are used for conversion.</remarks>
|
|
public object ReadYaml(IParser parser, Type type, ObjectDeserializer rootDeserializer)
|
|
{
|
|
var value = parser.Consume<Scalar>().Value;
|
|
var result = DateTimeOffset.ParseExact(value, formats, provider, dateStyle);
|
|
|
|
return result;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Writes the specified object's state to a YAML emitter.
|
|
/// </summary>
|
|
/// <param name="emitter"><see cref="IEmitter"/> instance.</param>
|
|
/// <param name="value">Value to write.</param>
|
|
/// <param name="type"><see cref="Type"/> to convert.</param>
|
|
/// <param name="serializer">A serializer to serializer complext objects.</param>
|
|
/// <remarks>On serializing, the first format in the list is used.</remarks>
|
|
public void WriteYaml(IEmitter emitter, object? value, Type type, ObjectSerializer serializer)
|
|
{
|
|
var dt = (DateTimeOffset)value!;
|
|
var formatted = dt.ToString(formats.First(), this.provider); // Always take the first format of the list.
|
|
|
|
emitter.Emit(new Scalar(AnchorName.Empty, TagName.Empty, formatted, style, true, false));
|
|
}
|
|
}
|
|
}
|