CodeGlyphX logo
CodeGlyphX

API Reference

Struct

DecodeResult`1

Namespace CodeGlyphX
Assembly CodeGlyphX
Base ValueType
Modifiers sealed

Represents the outcome of a decode attempt.

Inheritance

  • ValueType
  • DecodeResult`1

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Type Parameters

T

Constructors

DecodeResult 2 overloads
public DecodeResult<T>(T value, ImageInfo image, TimeSpan elapsed) #

Creates a successful decode result.

Parameters

value `0 requiredposition: 0
image CodeGlyphX.Rendering.ImageInfo requiredposition: 1
elapsed System.TimeSpan requiredposition: 2
public DecodeResult<T>(DecodeFailureReason failure, ImageInfo image, TimeSpan elapsed, String message = null) #

Creates a failed decode result.

Parameters

failure CodeGlyphX.DecodeFailureReason requiredposition: 0
image CodeGlyphX.Rendering.ImageInfo requiredposition: 1
elapsed System.TimeSpan requiredposition: 2
message System.String = null optionalposition: 3

Properties

public T Value { get; } #

Gets the decoded value when successful.

public DecodeFailureReason Failure { get; } #

Gets the failure reason.

public ImageInfo Image { get; } #

Gets image metadata when available.

public TimeSpan Elapsed { get; } #

Gets the elapsed decoding time.

public String Message { get; } #

Gets a human-friendly message describing the outcome.

public Boolean IsSuccess { get; } #

Gets a value indicating whether decoding succeeded.

public ImageFormat Format { get; } #

Gets the image format when available.

public Int32 Width { get; } #

Gets the image width when available.

public Int32 Height { get; } #

Gets the image height when available.