Class ReadContext

Context object provided during read operations.

Inheritance
System.Object
ReadContext
Implements
System.IEquatable<ReadContext>
Namespace: Cesil
Assembly: Cesil.dll
Syntax
public sealed class ReadContext : ValueType, IEquatable<ReadContext>

Properties

Column

The column being read.

Will throw if HasColumn == false, or Mode != ReadingColumn.

Declaration
public ColumnIdentifier Column { get; }
Property Value
Type Description
ColumnIdentifier

Context

The object, if any, provided to the call to CreateReader or CreateAsyncReader that produced the reader which is performing the read operation which is described by this context.

Declaration
public object Context { get; }
Property Value
Type Description
System.Object

HasColumn

Whether or not Column is available.

Declaration
public bool HasColumn { get; }
Property Value
Type Description
System.Boolean

Mode

What, precisely, a reader is doing.

Declaration
public ReadContextMode Mode { get; }
Property Value
Type Description
ReadContextMode

Options

Options used to create reader. Useful for accessing shared configurations, like MemoryPool(char).

Declaration
public Options Options { get; }
Property Value
Type Description
Options

RowNumber

The index of the row being read (0-based).

Declaration
public int RowNumber { get; }
Property Value
Type Description
System.Int32

Methods

Equals(ReadContext)

Returns true if this object equals the given ReadContext.

Declaration
public bool Equals(ReadContext context)
Parameters
Type Name Description
ReadContext context
Returns
Type Description
System.Boolean

Equals(Object)

Returns true if this object equals the given ReadContext.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean

GetHashCode()

Returns a stable hash for this ReadContext.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

ToString()

Returns a string representation of this ReadContext.

Declaration
public override string ToString()
Returns
Type Description
System.String

Operators

Equality(ReadContext, ReadContext)

Compare two ReadContexts for equality

Declaration
public static bool operator ==(ReadContext a, ReadContext b)
Parameters
Type Name Description
ReadContext a
ReadContext b
Returns
Type Description
System.Boolean

Inequality(ReadContext, ReadContext)

Compare two ReadContexts for inequality

Declaration
public static bool operator !=(ReadContext a, ReadContext b)
Parameters
Type Name Description
ReadContext a
ReadContext b
Returns
Type Description
System.Boolean

Implements

System.IEquatable<>
In This Article
Back to top Generated by DocFX