Class YamlResponseNegotiator

Namespace

Codebelt.Extensions.Carter.AspNetCore.Text.Yaml

Assembly

Codebelt.Extensions.Carter.AspNetCore.Text.Yaml.dll

Provides a YAML response negotiator for Carter, capable of serializing response models to YAML format.

public class YamlResponseNegotiator : ConfigurableResponseNegotiator<YamlFormatterOptions>, IConfigurable<YamlFormatterOptions>, IResponseNegotiator

Inheritance

object

Configurable<YamlFormatterOptions>

ConfigurableResponseNegotiator<YamlFormatterOptions>

YamlResponseNegotiator

Implements

IConfigurable<YamlFormatterOptions>

IResponseNegotiator

Inherited Members

ConfigurableResponseNegotiator<YamlFormatterOptions>.CanHandle(MediaTypeHeaderValue)

ConfigurableResponseNegotiator<YamlFormatterOptions>.ContentType

ConfigurableResponseNegotiator<YamlFormatterOptions>.GetEncoding(HttpRequest)

ConfigurableResponseNegotiator<YamlFormatterOptions>.Handle<T>(HttpRequest, HttpResponse, T, CancellationToken)

Configurable<YamlFormatterOptions>.Options

Constructors

YamlResponseNegotiator(IOptions<YamlFormatterOptions>)

Initializes a new instance of the YamlResponseNegotiator class.

public YamlResponseNegotiator(IOptions<YamlFormatterOptions> options)

Parameters

options IOptions<YamlFormatterOptions>

The YamlFormatterOptions used to configure YAML serialization and supported media types.

Methods

GetDefaultEncoding()

Returns the character encoding specified by the YamlFormatterOptions.

protected override Encoding GetDefaultEncoding()

Returns

Encoding

The default Encoding for this negotiator.

GetFormatter()

Returns a new YamlFormatter configured with the current YamlFormatterOptions.

public override StreamFormatter<YamlFormatterOptions> GetFormatter()

Returns

StreamFormatter<YamlFormatterOptions>

A YamlFormatter instance configured with the current YamlFormatterOptions.

See Also

ConfigurableResponseNegotiator<TOptions>