ConfigurationKeyOptions Class

Definition

Namespace: Bodu.Text.Configuration

Assembly: Bodu.Text.Configuration.dll

Package: Bodu.Text.Configuration 1.0.0

Source: ConfigurationKeyOptions.cs

Controls how raw configuration keys are split into segments and mapped to the colon-delimited logical key shape used by the resolved view and the Microsoft.Extensions.Configuration bridge.

public sealed class ConfigurationKeyOptions

Inheritance: object

ConfigurationKeyOptions

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

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

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

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

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

Remarks

Two questions need consistent answers for a configuration host: how are the dotted, colon-delimited, or mixed key forms in a source document split into segments, and under which comparer are the resulting keys looked up. ConfigurationKeyOptions answers both - SegmentSeparators drives splitting, Mapping drives the canonical join, and CaseSensitive drives the comparer exposed via KeyComparer and used for equality on every ConfigurationKey it produces.

The same instance is consumed by KeyOptions and KeyOptions; sharing one configured value across both keeps the parsed model and the resolved view's lookups consistent. The default Default mirrors Microsoft.Extensions.Configuration - case-insensitive ordinal comparison, dot-to-colon mapping, and { '.', ':' } as recognised separators.

Instances are immutable once constructed; init-only setters allow object-initializer syntax for callers that need to deviate from the defaults. Reuse a single configured instance across calls when consistency matters.

// Dotted keys normalize to colon-separated configuration paths by default;
// Identity keeps authored keys verbatim.
var options = new ConfigurationResolveOptions
{
    KeyOptions = new ConfigurationKeyOptions { Mapping = ConfigurationKeyMapping.Identity },
};

Constructors