ConfigurationKey Struct

Definition

Namespace

Bodu.Text.Configuration

Assembly

Bodu.Text.Configuration.dll

Package

Bodu.Text.Configuration 1.0.0

Source

ConfigurationKey.Parse.cs

Represents a configuration key in both its raw, file-level form and its colon-delimited logical form used by the resolved view and by Microsoft.Extensions.Configuration.

public readonly struct ConfigurationKey : IEquatable<ConfigurationKey>

Implements

IEquatable<ConfigurationKey>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

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>)

Examples

// Default mapping - split on '.' and ':', case-insensitive comparison.
var k1 = new ConfigurationKey("Logging.Level.Default");
var k2 = new ConfigurationKey("logging:level:default");
Console.WriteLine(k1 == k2);              // True - same segment sequence under the default comparer
Console.WriteLine(k1.Path);               // "Logging:Level:Default"
Console.WriteLine(string.Join(",", k1.Segments)); // "Logging,Level,Default"

// Case-sensitive parsing for hosts that distinguish 'Foo' from 'foo'.
var opts = new ConfigurationKeyOptions { CaseSensitive = true };
var k3   = new ConfigurationKey("Foo:Bar", opts);
var k4   = new ConfigurationKey("foo:bar", opts);
Console.WriteLine(k3 == k4);              // False

Remarks

The struct stores the input RawKey verbatim. Path is the canonical colon-joined form derived from Segments, applying the mapping policy from ConfigurationKeyOptions.

Equality compares the segment sequence under the configured comparer; the raw form is informational only.

Both dotted (logging.level.default) and colon-delimited (logging:level:default) source forms produce the same canonical Path, so consumers can mix the two notations in a document without disturbing the resolved view. Whitespace in segments is trimmed; control characters are rejected at construction time.

Constructors

ConfigurationKey(string, ConfigurationKeyOptions?)

Initializes a new instance of the ConfigurationKey struct from a raw key string using the supplied options.

public ConfigurationKey(string rawKey, ConfigurationKeyOptions? options = null)

Parameters

rawKey string

The raw key as authored in the configuration source.

options ConfigurationKeyOptions

The key options to apply, or null for the defaults.

Exceptions

ArgumentException

rawKey is null, empty, or contains only whitespace; or a segment was empty when empty segments are not permitted.

Properties

CaseSensitive

Gets a value indicating whether equality and hashing for this key are case-sensitive.

public bool CaseSensitive { get; }

Property Value

bool

true when ordinal case-sensitive comparison is used; otherwise, false for ordinal-ignore-case.

Path

Gets the canonical colon-delimited logical key path derived from Segments.

public string Path { get; }

Property Value

string

The configuration key in colon-delimited form, or the empty string for a default instance.

RawKey

Gets the raw key string exactly as it appeared in the source document.

public string RawKey { get; }

Property Value

string

The original key text, or the empty string for a default instance.

Segments

Gets the segments produced by splitting RawKey on the configured separators.

public ImmutableArray<string> Segments { get; }

Property Value

ImmutableArray<string>

An immutable array of segment strings.

Methods

Equals(ConfigurationKey)

Determines whether this key has the same segment sequence as other under the configured comparer.

public bool Equals(ConfigurationKey other)

Parameters

other ConfigurationKey

The other key to compare with.

Returns

bool

true when the segment sequences are equal under the chosen comparer; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

Parse(string)

Parses a raw configuration key into a ConfigurationKey using the default key options.

public static ConfigurationKey Parse(string rawKey)

Parameters

rawKey string

The raw key to parse.

Returns

ConfigurationKey

A ConfigurationKey built from rawKey.

Exceptions

ArgumentException

rawKey is null, empty, or contains only whitespace, or contains an empty segment when empty segments are not permitted.

Parse(string, ConfigurationKeyOptions?)

Parses a raw configuration key into a ConfigurationKey using the supplied options.

public static ConfigurationKey Parse(string rawKey, ConfigurationKeyOptions? options)

Parameters

rawKey string

The raw key to parse.

options ConfigurationKeyOptions

The key options to apply, or null for the defaults.

Returns

ConfigurationKey

A ConfigurationKey built from rawKey.

Exceptions

ArgumentException

rawKey is null, empty, or contains only whitespace, or contains an empty segment when empty segments are not permitted.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

TryParse(string?, out ConfigurationKey)

Attempts to parse a raw configuration key.

public static bool TryParse(string? rawKey, out ConfigurationKey result)

Parameters

rawKey string

The raw key to parse.

result ConfigurationKey

When this method returns, contains the parsed key if successful; otherwise, the default key.

Returns

bool

true when parsing succeeded; otherwise, false.

TryParse(string?, ConfigurationKeyOptions?, out ConfigurationKey)

Attempts to parse a raw configuration key using the supplied options.

public static bool TryParse(string? rawKey, ConfigurationKeyOptions? options, out ConfigurationKey result)

Parameters

rawKey string

The raw key to parse.

options ConfigurationKeyOptions

The key options to apply, or null for the defaults.

result ConfigurationKey

When this method returns, contains the parsed key if successful; otherwise, the default key.

Returns

bool

true when parsing succeeded; otherwise, false.

Operators

operator ==(ConfigurationKey, ConfigurationKey)

Determines whether two keys are equal.

public static bool operator ==(ConfigurationKey left, ConfigurationKey right)

Parameters

left ConfigurationKey

The first key to compare.

right ConfigurationKey

The second key to compare.

Returns

bool

true when the keys are equal; otherwise, false.

operator !=(ConfigurationKey, ConfigurationKey)

Determines whether two keys are not equal.

public static bool operator !=(ConfigurationKey left, ConfigurationKey right)

Parameters

left ConfigurationKey

The first key to compare.

right ConfigurationKey

The second key to compare.

Returns

bool

true when the keys differ; otherwise, false.

Applies to

Product	Versions
.NET	8, 10