XmlConverterExtensions Class

Definition

Namespace

Cuemon.Extensions.Xml.Serialization.Converters

Assemblies

Cuemon.Extensions.Xml.dll

Source

src/Cuemon.Extensions.Xml/Serialization/Converters/XmlConverterExtensions.cs

Extension methods for the XmlConverter class.

public static class XmlConverterExtensions

Inheritance

object

XmlConverterExtensions

Examples

XmlConverterExtensions provides extension methods for building a list of XmlConverter instances with both built-in and custom converters that can be reused through XmlSerializer. This example creates an IList<XmlConverter> and calls InsertXmlConverter<string> to register a custom string converter at position 0, AddXmlConverter<int> for an integer converter, and fluent methods like AddEnumerableConverter, AddExceptionDescriptorConverter, AddUriConverter, AddDateTimeConverter, AddTimeSpanConverter, AddStringConverter, AddExceptionConverter, and AddFailureConverter. It then uses FirstOrDefaultWriterConverter and FirstOrDefaultReaderConverter to query converters, applies them to XmlSerializerOptions, and serializes a Uri to XML. Console output confirms converter lookup results and displays the serialized XML.

using System;
using System.Collections.Generic;
using System.IO;
using System.Xml;
using Cuemon.Diagnostics;
using Cuemon.Extensions.Xml.Serialization.Converters;
using Cuemon.Xml.Serialization;
using Cuemon.Xml.Serialization.Converters;

namespace DocExamples;

public static class XmlConverterExtensionsExample
{
    public static void Demonstrate()
    {
        IList<XmlConverter> converters = new List<XmlConverter>();

        converters.InsertXmlConverter<string>(
            0,
            (writer, value, entity) => writer.WriteElementString(entity?.LocalName ?? "Value", value),
            (reader, objectType) => reader.ReadElementContentAsString(),
            objectType => objectType == typeof(string),
            new XmlQualifiedEntity("String"));

        converters.AddXmlConverter<int>(
            (writer, value, entity) => writer.WriteElementString(entity?.LocalName ?? "Value", value.ToString()),
            (reader, objectType) => reader.ReadElementContentAsInt(),
            objectType => objectType == typeof(int),
            new XmlQualifiedEntity("Int32"));

        converters.AddEnumerableConverter();
        converters.AddExceptionDescriptorConverter(options => options.SensitivityDetails = FaultSensitivityDetails.All);
        converters.AddUriConverter();
        converters.AddDateTimeConverter();
        converters.AddTimeSpanConverter();
        converters.AddStringConverter();
        converters.AddExceptionConverter(includeStackTrace: true, includeData: true);
        converters.AddFailureConverter();

        var writerConverter = converters.FirstOrDefaultWriterConverter(typeof(Uri));
        var readerConverter = converters.FirstOrDefaultReaderConverter(typeof(string));

        var serializerOptions = new XmlSerializerOptions();
        serializerOptions.Converters.Clear();
        foreach (var converter in converters)
        {
            serializerOptions.Converters.Add(converter);
        }

        var serializer = XmlSerializer.Create(serializerOptions);
        using var stream = serializer.Serialize(new Uri("https://example.com/feed.xml"), typeof(Uri));
        using var xml = new StreamReader(stream);

        Console.WriteLine(writerConverter is not null && readerConverter is not null);
        Console.WriteLine(xml.ReadToEnd());
    }
}

Methods

Name	Description
AddDateTimeConverter(IList<XmlConverter>)	Adds an DateTime XML converter to the list.
AddEnumerableConverter(IList<XmlConverter>, bool)	Adds an IEnumerable XML converter to the list.
AddExceptionConverter(IList<XmlConverter>, bool, bool)	Adds an Exception XML converter to the list.
AddExceptionDescriptorConverter(IList<XmlConverter>, Action<ExceptionDescriptorOptions>)	Adds an ExceptionDescriptor XML converter to the list.
AddFailureConverter(IList<XmlConverter>)	Adds an Failure XML converter to the list.
AddStringConverter(IList<XmlConverter>)	Adds an string XML converter to the list.
AddTimeSpanConverter(IList<XmlConverter>)	Adds an TimeSpan XML converter to the list.
AddUriConverter(IList<XmlConverter>)	Adds a Uri XML converter to the list.
AddXmlConverter<T>(IList<XmlConverter>, Action<XmlWriter, T, XmlQualifiedEntity>, Func<XmlReader, Type, T>, Func<Type, bool>, XmlQualifiedEntity)	Adds an XML converter to the list.
FirstOrDefaultReaderConverter(IList<XmlConverter>, Type)	Returns the first XmlConverter of the converters that CanConvert(Type) and CanRead the specified objectType; otherwise null if no XmlConverter is found.
FirstOrDefaultWriterConverter(IList<XmlConverter>, Type)	Returns the first XmlConverter of the converters that CanConvert(Type) and CanWrite the specified objectType; otherwise null if no XmlConverter is found.
InsertXmlConverter<T>(IList<XmlConverter>, int, Action<XmlWriter, T, XmlQualifiedEntity>, Func<XmlReader, Type, T>, Func<Type, bool>, XmlQualifiedEntity)	Inserts an XML converter to the list at the specified index.