IniReaderOptions Struct

Definition

Namespace

Bodu.Text.Ini.Reader

Assembly

Bodu.Text.Ini.dll

Package

Bodu.Text.Ini 1.0.0

Source

IniReaderOptions.cs

Provides configuration for a Utf8IniReader, controlling comment recognition.

public readonly struct IniReaderOptions

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

BufferConverter.CopyTo<T>(T, byte[], int)

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.Clamp<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.IsBetween<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.IsGreaterThanOrEqual<T>(T, T?, IComparer<T>)

ComparableExtensions.IsGreaterThan<T>(T, T?, IComparer<T>)

ComparableExtensions.IsLessThanOrEqual<T>(T, T?, IComparer<T>)

ComparableExtensions.IsLessThan<T>(T, T?, IComparer<T>)

ComparableExtensions.IsOutside<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Remarks

The reader is source-order and does not itself resolve duplicate sections/keys or apply case rules - those are document-model concerns. Inline comments are deliberately not recognized: a value retains everything after the assignment to the end of the line, matching the safer configparser dialect and avoiding the classic value ; not-a-comment footgun.

Properties

Default

Gets the default reader options (both ; and # begin comments, comments surfaced as tokens).

public static IniReaderOptions Default { get; }

Property Value

IniReaderOptions

The default options.

DisallowHashComments

Gets a value indicating whether a leading # is rejected as a comment prefix, leaving ; as the only comment character.

public bool DisallowHashComments { get; init; }

Property Value

bool

true to disable # comments; otherwise false.

Remarks

The property is inverted so the parameterless Default accepts both comment characters.

SkipComments

Gets a value indicating whether comment lines are surfaced as Comment tokens.

public bool SkipComments { get; init; }

Property Value

bool

true to skip comment tokens; otherwise false.

Remarks

The property is inverted so the parameterless Default preserves comments.

Applies to

Product	Versions
.NET	8, 10