StreamOutputFormatter<TFormatter, TOptions> Class

Definition

Namespace

Cuemon.AspNetCore.Mvc.Formatters

Assemblies

Cuemon.AspNetCore.Mvc.dll

Source

src/Cuemon.AspNetCore.Mvc/Formatters/StreamOutputFormatter.cs

Provides a way to write an object in a given text format to the output stream with the constraint that TFormatter must be assignable from Formatter<TFormat>. Implements the ConfigurableOutputFormatter<TOptions>

public abstract class StreamOutputFormatter<TFormatter, TOptions> : ConfigurableOutputFormatter<TOptions>, IOutputFormatter, IApiResponseTypeMetadataProvider, IConfigurable<TOptions> where TFormatter : Formatter<Stream> where TOptions : class, IParameterObject, new()

Type Parameters

TFormatter

The type of the Formatter<TFormat>.

TOptions

The type of the configured options.

Inheritance

object

OutputFormatter

TextOutputFormatter

ConfigurableOutputFormatter<TOptions>

StreamOutputFormatter<TFormatter, TOptions>

Implements

IOutputFormatter

IApiResponseTypeMetadataProvider

IConfigurable<TOptions>

Inherited Members

ConfigurableOutputFormatter<TOptions>.Options

TextOutputFormatter.SelectCharacterEncoding(OutputFormatterWriteContext)

TextOutputFormatter.WriteAsync(OutputFormatterWriteContext)

TextOutputFormatter.WriteResponseBodyAsync(OutputFormatterWriteContext)

TextOutputFormatter.SupportedEncodings

OutputFormatter.CanWriteType(Type)

OutputFormatter.GetSupportedContentTypes(string, Type)

OutputFormatter.CanWriteResult(OutputFormatterCanWriteContext)

OutputFormatter.WriteResponseHeaders(OutputFormatterWriteContext)

OutputFormatter.SupportedMediaTypes

Constructors

Name	Description
StreamOutputFormatter(TOptions)	Initializes a new instance of the StreamOutputFormatter<TFormatter, TOptions> class.

Methods

Name	Description
WriteResponseBodyAsync(OutputFormatterWriteContext, Encoding)	write response body as an asynchronous operation.