Interface IBoundConfiguration<TRow>
Represents and Options and Type pair.
Used to create readers and writers.
Namespace: Cesil
Assembly: Cesil.dll
Syntax
public interface IBoundConfiguration<TRow>Type Parameters
| Name | Description |
|---|---|
| TRow |
Properties
Options
The Options used to create this configuration.
If any settings are used that defer decisions (like ReadHeader.Detect) this Options object will remain unchanged when a decision is made. In other words, this Options object will always match what was used to create the configuration - it is not updated.
Declaration
Options Options { get; }Property Value
| Type | Description |
|---|---|
| Options |
Methods
CreateAsyncReader(PipeReader, Encoding, Object)
Create an asynchronous reader for the given reader.
The provided encoding is used to convert the bytes provided by the reader into characters for parsing.
Takes an optional context object which is made available during certain operations as a member on ReadContext.
Declaration
IAsyncReader<TRow> CreateAsyncReader(PipeReader reader, Encoding encoding, object context = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Pipelines.PipeReader | reader | |
| System.Text.Encoding | encoding | |
| System.Object | context |
Returns
| Type | Description |
|---|---|
| IAsyncReader<TRow> |
CreateAsyncReader(TextReader, Object)
Create an asynchronous reader for the given reader.
Takes an optional context object which is made available during certain operations as a member on ReadContext.
Declaration
IAsyncReader<TRow> CreateAsyncReader(TextReader reader, object context = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.TextReader | reader | |
| System.Object | context |
Returns
| Type | Description |
|---|---|
| IAsyncReader<TRow> |
CreateAsyncWriter(PipeWriter, Encoding, Object)
Create an asynchronous writer for the given writer.
The provided encoding is used to convert characters into bytes.
Takes an optional context object which is made available during certain operations as a member on WriteContext.
Declaration
IAsyncWriter<TRow> CreateAsyncWriter(PipeWriter writer, Encoding encoding, object context = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Pipelines.PipeWriter | writer | |
| System.Text.Encoding | encoding | |
| System.Object | context |
Returns
| Type | Description |
|---|---|
| IAsyncWriter<TRow> |
CreateAsyncWriter(TextWriter, Object)
Create an asynchronous writer for the given writer.
Takes an optional context object which is made available during certain operations as a member on WriteContext.
Declaration
IAsyncWriter<TRow> CreateAsyncWriter(TextWriter writer, object context = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.TextWriter | writer | |
| System.Object | context |
Returns
| Type | Description |
|---|---|
| IAsyncWriter<TRow> |
CreateReader(ReadOnlySequence<Byte>, Encoding, Object)
Create a synchronous reader for the given sequence, converting bytes to characters using the provided encoding.
Takes an optional context object which is made available during certain operations as a member on ReadContext.
Declaration
IReader<TRow> CreateReader(ReadOnlySequence<byte> sequence, Encoding encoding, object context = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Buffers.ReadOnlySequence<System.Byte> | sequence | |
| System.Text.Encoding | encoding | |
| System.Object | context |
Returns
| Type | Description |
|---|---|
| IReader<TRow> |
CreateReader(ReadOnlySequence<Char>, Object)
Create a synchronous reader for the given sequence.
Takes an optional context object which is made available during certain operations as a member on ReadContext.
Declaration
IReader<TRow> CreateReader(ReadOnlySequence<char> sequence, object context = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Buffers.ReadOnlySequence<System.Char> | sequence | |
| System.Object | context |
Returns
| Type | Description |
|---|---|
| IReader<TRow> |
CreateReader(TextReader, Object)
Create a synchronous reader for the given reader.
Takes an optional context object which is made available during certain operations as a member on ReadContext.
Declaration
IReader<TRow> CreateReader(TextReader reader, object context = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.TextReader | reader | |
| System.Object | context |
Returns
| Type | Description |
|---|---|
| IReader<TRow> |
CreateWriter(IBufferWriter<Byte>, Encoding, Object)
Create a synchronous writer for the given writer, converting chars to bytes using the given encoding.
Takes an optional context object which is made available during certain operations as a member on WriteContext.
Declaration
IWriter<TRow> CreateWriter(IBufferWriter<byte> writer, Encoding encoding, object context = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Buffers.IBufferWriter<System.Byte> | writer | |
| System.Text.Encoding | encoding | |
| System.Object | context |
Returns
| Type | Description |
|---|---|
| IWriter<TRow> |
CreateWriter(IBufferWriter<Char>, Object)
Create a synchronous writer for the given writer.
Takes an optional context object which is made available during certain operations as a member on WriteContext.
Declaration
IWriter<TRow> CreateWriter(IBufferWriter<char> writer, object context = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Buffers.IBufferWriter<System.Char> | writer | |
| System.Object | context |
Returns
| Type | Description |
|---|---|
| IWriter<TRow> |
CreateWriter(TextWriter, Object)
Create a synchronous writer for the given writer.
Takes an optional context object which is made available during certain operations as a member on WriteContext.
Declaration
IWriter<TRow> CreateWriter(TextWriter writer, object context = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.TextWriter | writer | |
| System.Object | context |
Returns
| Type | Description |
|---|---|
| IWriter<TRow> |