Class DecoderInfo

Describes an image codec.

Inheritance

System.Object

CodecInfo

DecoderInfo

Implements

System.IEquatable<CodecInfo>

IImageDecoderInfo

IImageCodecInfo

System.IEquatable<DecoderInfo>

Inherited Members

CodecInfo.Deconstruct(String, IEnumerable<String>, IEnumerable<String>)

CodecInfo.Name

CodecInfo.MimeTypes

CodecInfo.FileExtensions

Namespace: PhotoSauce.MagicScaler

Assembly: PhotoSauce.MagicScaler.dll

Syntax

public sealed class DecoderInfo : CodecInfo, IImageDecoderInfo, IImageCodecInfo

Constructors

DecoderInfo(String, IEnumerable<String>, IEnumerable<String>, IEnumerable<ContainerPattern>, IDecoderOptions, Func<Stream, IDecoderOptions, IImageContainer>)

The friendly name of the codec.

Declaration

public DecoderInfo(string Name, IEnumerable<string> MimeTypes, IEnumerable<string> FileExtensions, IEnumerable<ContainerPattern> Patterns, IDecoderOptions DefaultOptions, Func<Stream, IDecoderOptions, IImageContainer> Factory)

Parameters

Type	Name	Description
System.String	Name	The friendly name of the codec.
System.Collections.Generic.IEnumerable<System.String>	MimeTypes	A list of MIME types supported by the codec.
System.Collections.Generic.IEnumerable<System.String>	FileExtensions	A list of file extensions supported by the codec.
System.Collections.Generic.IEnumerable<ContainerPattern>	Patterns	A list of "magic byte" patterns that may match files this decoder can read.
IDecoderOptions	DefaultOptions	Default codec options to be used for this decoder in the absence of per-instance overrides.
System.Func<System.IO.Stream, IDecoderOptions, IImageContainer>	Factory	A delegate capable of creating an instance of this decoder over a given System.IO.Stream data source.

Properties

DefaultOptions

Default codec options to be used for this decoder in the absence of per-instance overrides.

Declaration

public IDecoderOptions DefaultOptions { get; set; }

Property Value

Type	Description
IDecoderOptions

EqualityContract

Declaration

protected override Type EqualityContract { get; }

Property Value

Type	Description
System.Type

Overrides

CodecInfo.EqualityContract

Factory

A delegate capable of creating an instance of this decoder over a given System.IO.Stream data source.

Declaration

public Func<Stream, IDecoderOptions, IImageContainer> Factory { get; set; }

Property Value

Type	Description
System.Func<System.IO.Stream, IDecoderOptions, IImageContainer>

Patterns

A list of "magic byte" patterns that may match files this decoder can read.

Declaration

public IEnumerable<ContainerPattern> Patterns { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ContainerPattern>

Methods

<Clone>$()

Declaration

public override CodecInfo <Clone>$()

Returns

Type	Description
CodecInfo

Overrides

CodecInfo.<Clone>$()

Deconstruct(out String, out IEnumerable<String>, out IEnumerable<String>, out IEnumerable<ContainerPattern>, out IDecoderOptions, out Func<Stream, IDecoderOptions, IImageContainer>)

Declaration

public void Deconstruct(out string Name, out IEnumerable<string> MimeTypes, out IEnumerable<string> FileExtensions, out IEnumerable<ContainerPattern> Patterns, out IDecoderOptions DefaultOptions, out Func<Stream, IDecoderOptions, IImageContainer> Factory)

Parameters

Type	Name	Description
System.String	Name
System.Collections.Generic.IEnumerable<System.String>	MimeTypes
System.Collections.Generic.IEnumerable<System.String>	FileExtensions
System.Collections.Generic.IEnumerable<ContainerPattern>	Patterns
IDecoderOptions	DefaultOptions
System.Func<System.IO.Stream, IDecoderOptions, IImageContainer>	Factory

Equals(CodecInfo)

Declaration

public sealed override bool Equals(CodecInfo other)

Parameters

Type	Name	Description
CodecInfo	other

Returns

Type	Description
System.Boolean

Overrides

CodecInfo.Equals(CodecInfo)

Equals(DecoderInfo)

Declaration

public bool Equals(DecoderInfo other)

Parameters

Type	Name	Description
DecoderInfo	other

Returns

Type	Description
System.Boolean

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

CodecInfo.Equals(Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

CodecInfo.GetHashCode()

PrintMembers(StringBuilder)

Declaration

protected override bool PrintMembers(StringBuilder builder)

Parameters

Type	Name	Description
System.Text.StringBuilder	builder

Returns

Type	Description
System.Boolean

Overrides

CodecInfo.PrintMembers(StringBuilder)

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

CodecInfo.ToString()

Operators

Equality(DecoderInfo, DecoderInfo)

Declaration

public static bool operator ==(DecoderInfo left, DecoderInfo right)

Parameters

Type	Name	Description
DecoderInfo	left
DecoderInfo	right

Returns

Type	Description
System.Boolean

Inequality(DecoderInfo, DecoderInfo)

Declaration

public static bool operator !=(DecoderInfo left, DecoderInfo right)

Parameters

Type	Name	Description
DecoderInfo	left
DecoderInfo	right

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<>

IImageDecoderInfo

IImageCodecInfo

System.IEquatable<>