Class ReadWithCommentResult<TRow>

Represents the result of an attempted read operation which supports comments.

Inheritance
System.Object
ReadWithCommentResult<TRow>
Namespace: Cesil
Assembly: Cesil.dll
Syntax
public sealed class ReadWithCommentResult<TRow> : ValueType
Type Parameters
Name Description
TRow

Properties

Comment

The comment read, if ResultType == HasComment.

Throws otherwise.

Declaration
public string Comment { get; }
Property Value
Type Description
System.String

HasComment

Convenience method for checking ResultType == HasComment

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

HasValue

Convenience method for checking ResultType == HasValue

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

ResultType

Indicates what, if anything, is available on this result.

If NoValue, no more results will be read.

Declaration
public ReadWithCommentResultType ResultType { get; }
Property Value
Type Description
ReadWithCommentResultType

Value

The value read, if ResultType == HasValue.

Throws otherwise.

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

Methods

ToString()

Returns a representation of this ReadResult struct.

Only for debugging, this value is not guaranteed to be stable.

Declaration
public override string ToString()
Returns
Type Description
System.String
In This Article
Back to top Generated by DocFX