XmlSerializationInputFormatter Class

Definition

Namespace

Cuemon.Extensions.AspNetCore.Mvc.Formatters.Xml

Assemblies

Cuemon.Extensions.AspNetCore.Mvc.Formatters.Xml.dll

Source

src/Cuemon.Extensions.AspNetCore.Mvc.Formatters.Xml/XmlSerializationInputFormatter.cs

This class handles deserialization of XML to objects using XmlFormatter.

public class XmlSerializationInputFormatter : StreamInputFormatter<XmlFormatter, XmlFormatterOptions>, IInputFormatter, IApiRequestFormatMetadataProvider, IConfigurable<XmlFormatterOptions>

Inheritance

object

InputFormatter

TextInputFormatter

ConfigurableInputFormatter<XmlFormatterOptions>

StreamInputFormatter<XmlFormatter, XmlFormatterOptions>

XmlSerializationInputFormatter

Implements

IInputFormatter

IApiRequestFormatMetadataProvider

IConfigurable<XmlFormatterOptions>

Inherited Members

StreamInputFormatter<XmlFormatter, XmlFormatterOptions>.ReadRequestBodyAsync(InputFormatterContext, Encoding)

ConfigurableInputFormatter<XmlFormatterOptions>.Options

TextInputFormatter.UTF8EncodingWithoutBOM

TextInputFormatter.UTF16EncodingLittleEndian

TextInputFormatter.ReadRequestBodyAsync(InputFormatterContext)

TextInputFormatter.ReadRequestBodyAsync(InputFormatterContext, Encoding)

TextInputFormatter.SelectCharacterEncoding(InputFormatterContext)

TextInputFormatter.SupportedEncodings

InputFormatter.GetDefaultValueForType(Type)

InputFormatter.CanRead(InputFormatterContext)

InputFormatter.CanReadType(Type)

InputFormatter.ReadAsync(InputFormatterContext)

InputFormatter.GetSupportedContentTypes(string, Type)

InputFormatter.SupportedMediaTypes

Extension Methods

CacheableObjectResultExtensions.WithCacheableHeaders<T>(T, Action<CacheableObjectResultOptions<T>>)

CacheableObjectResultExtensions.WithEntityTagHeader<T>(T, Action<ContentBasedObjectResultOptions<T>>)

CacheableObjectResultExtensions.WithLastModifiedHeader<T>(T, Action<TimeBasedObjectResultOptions<T>>)

Examples

The following example demonstrates how to construct an and inspect its supported media types and encodings.

using System;
using System.Linq;
using Cuemon.Extensions.AspNetCore.Mvc.Formatters.Xml;
using Cuemon.Xml.Serialization.Formatters;

namespace DocfxExamples;

public class XmlSerializationInputFormatterExample
{
    public void Demonstrate()
    {
        var options = new XmlFormatterOptions();
        var formatter = new XmlSerializationInputFormatter(options);

        Console.WriteLine($"Supported media types: {string.Join(", ", formatter.SupportedMediaTypes)}");
        Console.WriteLine($"Supported encodings: {string.Join(", ", formatter.SupportedEncodings.Select(e => e.WebName))}");

}
}

Constructors

Name	Description
XmlSerializationInputFormatter(XmlFormatterOptions)	Initializes a new instance of the XmlSerializationInputFormatter class.