Class AsyncStreamReaderOptions

Namespace

Cuemon.IO

Assembly

Cuemon.IO.dll

Configuration options for StreamReader.

public class AsyncStreamReaderOptions : AsyncStreamEncodingOptions, IAsyncOptions, IParameterObject, IEncodingOptions

Inheritance

object

AsyncOptions

AsyncDisposableOptions

AsyncStreamEncodingOptions

AsyncStreamReaderOptions

Implements

IAsyncOptions

IParameterObject

IEncodingOptions

Inherited Members

AsyncStreamEncodingOptions.Preamble

AsyncStreamEncodingOptions.Encoding

AsyncDisposableOptions.LeaveOpen

AsyncOptions.CancellationToken

AsyncOptions.CancellationTokenProvider

Examples

AsyncStreamReaderOptions configures encoding, preamble handling, and buffer size for asynchronous stream reading operations. This example creates a MemoryStream with UTF-8 preamble bytes followed by "Hej Cuemon" text, sets up options with PreambleSequence.Remove to strip the BOM, Encoding = EncodingOptions.DefaultEncoding for auto-detection, and BufferSize = 4096, then calls ToEncodedStringAsync via the decorator pattern. Console output shows the encoding web name (utf-8) and the decoded text with the preamble stripped, confirming correct preamble handling.

using System;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Cuemon;
using Cuemon.IO;
using Cuemon.Text;

namespace Contoso.Imports;

public sealed class AsyncStreamReaderOptionsExample
{
    public static async Task RunAsync()
    {
        byte[] payload = Encoding.UTF8.GetPreamble()
            .Concat(Encoding.UTF8.GetBytes("Hej Cuemon"))
            .ToArray();

        using var stream = new MemoryStream(payload);

        var options = new AsyncStreamReaderOptions
        {
            BufferSize = 4096,
            Encoding = EncodingOptions.DefaultEncoding,
            Preamble = PreambleSequence.Remove,
            LeaveOpen = true
        };

        string text = await Decorator.Enclose(stream).ToEncodedStringAsync(setup =>
        {
            setup.BufferSize = options.BufferSize;
            setup.Encoding = options.Encoding;
            setup.Preamble = options.Preamble;
            setup.LeaveOpen = options.LeaveOpen;
        });

        Console.WriteLine($"{options.Encoding.WebName}:{text}");
    }
}

Constructors

AsyncStreamReaderOptions()

Initializes a new instance of the AsyncStreamReaderOptions class.

public AsyncStreamReaderOptions()

Remarks

The following table shows the initial property values for an instance of AsyncStreamReaderOptions.

Property	Initial Value
Preamble	DefaultPreambleSequence
Encoding	DefaultEncoding
BufferSize	81920

Properties

BufferSize

Gets or sets the size of the buffer.

public int BufferSize { get; set; }

Property Value

int

The size of the buffer.

Exceptions

ArgumentOutOfRangeException

value is lower than or equal to 0.