BufferWriterOptions Class

Definition

Namespace

Cuemon.IO

Assemblies

Cuemon.IO.dll

Source

src/Cuemon.IO/BufferWriterOptions.cs

Configuration options for IBufferWriter<T>.

public class BufferWriterOptions : StreamEncodingOptions, IParameterObject, IEncodingOptions

Inheritance

object

DisposableOptions

StreamEncodingOptions

BufferWriterOptions

Implements

IParameterObject

IEncodingOptions

Inherited Members

StreamEncodingOptions.Preamble

StreamEncodingOptions.Encoding

DisposableOptions.LeaveOpen

Examples

The following example demonstrates how to configure BufferWriterOptions and use it with an IBufferWriter<byte> to produce a string.

using System;
using System.Buffers;
using System.Text;
using Cuemon.IO;
using Cuemon.Text;

namespace MyApp.Examples;

public class BufferWriterOptionsExample
{
    public static void Main()
    {
        var options = new BufferWriterOptions
        {
            BufferSize = 1024,
            Encoding = Encoding.UTF8,
            Preamble = PreambleSequence.Remove
        };

        var writer = new ArrayBufferWriter<byte>(options.BufferSize);
        byte[] data = Encoding.UTF8.GetBytes("Hello, BufferWriterOptions!");
        writer.Write(data);

        string result = Encoding.UTF8.GetString(writer.WrittenSpan);
        Console.WriteLine(result);

        // Output:
        // Hello, BufferWriterOptions!

}
}

Constructors

Name	Description
BufferWriterOptions()	Initializes a new instance of the BufferWriterOptions class.

Properties

Name	Description
BufferSize	Gets or sets the minimum capacity with which to initialize the underlying buffer.