Class OptionalTypeParser<TOpt, T>

Namespace

Rinku.Mapping.Parsers.Defaults

Assembly

Rinku.dll

The parser behind the optional shapes (Optional<T> and kin). It wraps an element parser and turns a missing row into that shape's empty value instead of throwing.

public sealed class OptionalTypeParser<TOpt, T> : BaseTypeParser<TOpt>, ITypeParser<TOpt>, ITypeParser, IDisposable where TOpt : struct, IWrapping<TOpt, T>

Type Parameters

TOpt

T

Inheritance

object

BaseTypeParser<TOpt>

OptionalTypeParser<TOpt, T>

Implements

ITypeParser<TOpt>

ITypeParser

IDisposable

Inherited Members

BaseTypeParser<TOpt>.Dispose()

BaseTypeParser<TOpt>.Query(DbCommand, bool)

BaseTypeParser<TOpt>.Query(IDbCommand, bool)

BaseTypeParser<TOpt>.QueryAsync(DbCommand, bool, CancellationToken)

BaseTypeParser<TOpt>.QueryAsync(IDbCommand, bool, CancellationToken)

BaseTypeParser<TOpt>.Query(DbCommand, ICache, bool)

BaseTypeParser<TOpt>.Query(IDbCommand, ICache, bool)

BaseTypeParser<TOpt>.QueryAsync(DbCommand, ICache, bool, CancellationToken)

BaseTypeParser<TOpt>.QueryAsync(IDbCommand, ICache, bool, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Caster.Parse<T>(object?)

Constructors

OptionalTypeParser(ITypeParser<T>)

The parser behind the optional shapes (Optional<T> and kin). It wraps an element parser and turns a missing row into that shape's empty value instead of throwing.

public OptionalTypeParser(ITypeParser<T> elementParser)

Parameters

elementParser ITypeParser<T>

Properties

Behavior

The reader behavior this parser wants, passed to ExecuteReader(CommandBehavior).

public override CommandBehavior Behavior { get; }

Property Value

CommandBehavior

Remarks

Often SequentialAccess or SingleResult.

Methods

CanParse(ColumnInfo[])

Whether this parser can read a result carrying schema.

public override bool CanParse(ColumnInfo[] schema)

Parameters

schema ColumnInfo[]

Returns

bool

Remarks

A parser may accept several schemas. A parser that reads names and types at each call may accept every schema.

Default()

The value to return when the result has no row, an empty collection or optional, for instance.

public override TOpt Default()

Returns

TOpt

Parse(DbDataReader)

Parses one T starting at the current row, advancing the reader as it goes. CanContinue reports the state of the reader on return, true when it is positioned on an untreated row, false when no row is left

public override (bool CanContinue, TOpt Result) Parse(DbDataReader reader)

Parameters

reader DbDataReader

Returns

(bool CanContinue, TOpt Result)

ParseAsync(DbDataReader, CancellationToken)

Parses one T starting at the current row, advancing the reader as it goes. CanContinue reports the state of the reader on return, true when it is positioned on an untreated row, false when no row is left

public override ValueTask<(bool CanContinue, TOpt Result)> ParseAsync(DbDataReader reader, CancellationToken ct = default)

Parameters

reader DbDataReader

ct CancellationToken

Returns

ValueTask<(bool CanContinue, TOpt Result)>