Class CsvAsyncStreamInput

Implementation of CsvAsyncInputBase backed by a Stream.

Inheritance

Object

CsvAsyncInputBase

CsvAsyncStreamInput

Inherited Members

CsvAsyncInputBase.ProcessAsync(CsvReaderVisitorBase, IProgress<Int32>, CancellationToken)

CsvAsyncInputBase.ThrowIfProcessingHasAlreadyStarted()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Cursively.Inputs

Assembly: Cursively.dll

Syntax

public sealed class CsvAsyncStreamInput : CsvAsyncInputBase

Methods

ProcessAsyncCore(CsvReaderVisitorBase, IProgress<Int32>, CancellationToken)

Implements the inner logic for ProcessAsync(CsvReaderVisitorBase, IProgress<Int32>, CancellationToken).

Declaration

protected override ValueTask ProcessAsyncCore(CsvReaderVisitorBase visitor, IProgress<int> progress, CancellationToken cancellationToken)

Parameters

Type	Name	Description
CsvReaderVisitorBase	visitor	The CsvReaderVisitorBase to describe this CSV data stream to.
IProgress<Int32>	progress	An optional IProgress<T> instance that will receive a report of the size of each chunk (in bytes) as processing finishes, followed by one more report with a zero when the last chunk in the stream has been processed.
CancellationToken	cancellationToken	An optional CancellationToken that may be used to signal cancellation.

Returns

Type	Description
ValueTask	A ValueTask encapsulating the operation.

Overrides

CsvAsyncInputBase.ProcessAsyncCore(CsvReaderVisitorBase, IProgress<Int32>, CancellationToken)

Exceptions

Type	Condition
InvalidOperationException	Thrown when this stream has already been processed.
OperationCanceledException	Thrown to acknowledge a canceled cancellationToken. Some subclasses may throw an instance of a subclass, such as TaskCanceledException.

WithDelimiter(Byte)

Creates a new instance of the CsvAsyncStreamInput class as a copy of this one, with the given delimiter.

Declaration

public CsvAsyncStreamInput WithDelimiter(byte delimiter)

Parameters

Type	Name	Description
Byte	delimiter	The delimiter to use. Use IsValidDelimiter(Byte) to test whether or not a particular value is valid.

Returns

Type	Description
CsvAsyncStreamInput	A new instance of the CsvAsyncStreamInput class as a copy of this one, with the given delimiter.

Exceptions

Type	Condition
ArgumentException	Thrown when delimiter is one of the illegal values.
InvalidOperationException	Thrown when ProcessAsync(CsvReaderVisitorBase, IProgress<Int32>, CancellationToken) has already been called.

WithIgnoreUTF8ByteOrderMark(Boolean)

Creates a new instance of the CsvAsyncStreamInput class as a copy of this one, with the given flag indicating whether or not a leading UTF-8 byte order mark, if present, should be omitted from the first field's data.

Declaration

public CsvAsyncStreamInput WithIgnoreUTF8ByteOrderMark(bool ignoreUTF8ByteOrderMark)

Parameters

Type	Name	Description
Boolean	ignoreUTF8ByteOrderMark	A value indicating whether or not a leading UTF-8 byte order mark, if present, should be omitted from the first field's data.

Returns

Type	Description
CsvAsyncStreamInput	A new instance of the CsvAsyncStreamInput class as a copy of this one, with the given flag indicating whether or not a leading UTF-8 byte order mark, if present, should be omitted from the first field's data.

Exceptions

Type	Condition
InvalidOperationException	Thrown when ProcessAsync(CsvReaderVisitorBase, IProgress<Int32>, CancellationToken) has already been called.

WithMinReadBufferByteCount(Int32)

Creates a new instance of the CsvAsyncStreamInput class as a copy of this one, reading in chunks of sizes that are at least the given number of bytes.

Declaration

public CsvAsyncStreamInput WithMinReadBufferByteCount(int minReadBufferByteCount)

Parameters

Type	Name	Description
Int32	minReadBufferByteCount	The minimum size, in bytes, of chunks to read from the buffer. When using an ArrayPool<T>, this is the value that will be used for Rent(Int32), so larger chunks should be expected. When not using an ArrayPool<T> (i.e., on instances configured by calling WithReadBufferPool(ArrayPool<Byte>) passing in null), this is the actual size of any arrays that will be allocated on the managed heap.

Returns

Type	Description
CsvAsyncStreamInput	A new instance of the CsvAsyncStreamInput class as a copy of this one, using the given ArrayPool<T> to provide temporary buffers for the Stream to read into.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown when minReadBufferByteCount is not greater than zero.
InvalidOperationException	Thrown when ProcessAsync(CsvReaderVisitorBase, IProgress<Int32>, CancellationToken) has already been called.

WithReadBufferPool(ArrayPool<Byte>)

Creates a new instance of the CsvAsyncStreamInput class as a copy of this one, using the given ArrayPool<T> to provide temporary buffers for the Stream to read into.

Declaration

public CsvAsyncStreamInput WithReadBufferPool(ArrayPool<byte> readBufferPool)

Parameters

Type	Name	Description
ArrayPool<Byte>	readBufferPool	The ArrayPool<T> to provide temporary buffers for the Stream to read into, or null if the temporary buffers should be allocated directly on the managed heap.

Returns

Type	Description
CsvAsyncStreamInput	A new instance of the CsvAsyncStreamInput class as a copy of this one, using the given ArrayPool<T> to provide temporary buffers for the Stream to read into.

Exceptions

Type	Condition
InvalidOperationException	Thrown when ProcessAsync(CsvReaderVisitorBase, IProgress<Int32>, CancellationToken) has already been called.