TextConfigurationProvider Class

Definition

Namespace

Bodu.Extensions.Configuration.Text

Assembly

Bodu.Extensions.Configuration.Text.dll

Package

Bodu.Extensions.Configuration.Text 1.0.0

Source

TextConfigurationProvider.cs

A FileConfigurationProvider that parses a Bodu Text Configuration file and populates the configuration data dictionary with the resolved colon-delimited keys.

public sealed class TextConfigurationProvider : FileConfigurationProvider, IConfigurationProvider, IDisposable

Inheritance

object

ConfigurationProvider

FileConfigurationProvider

TextConfigurationProvider

Implements

IConfigurationProvider

IDisposable

Inherited Members

FileConfigurationProvider.ToString()

FileConfigurationProvider.Load()

FileConfigurationProvider.Dispose()

FileConfigurationProvider.Source

ConfigurationProvider.TryGet(string, out string)

ConfigurationProvider.Set(string, string)

ConfigurationProvider.GetChildKeys(IEnumerable<string>, string)

ConfigurationProvider.GetReloadToken()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

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

Examples

// Diagnostic introspection: locate the Bodu provider after the configuration root has been built.
IConfigurationRoot root = builder.Build();
TextConfigurationProvider? bodu = root.Providers
    .OfType<TextConfigurationProvider>()
    .FirstOrDefault();

if (bodu is not null)
{
    Console.WriteLine($"Loaded from: {bodu.TextSource.Path}");
    Console.WriteLine($"Reload on change: {bodu.TextSource.ReloadOnChange}");
}

Remarks

The provider inherits change-token, reload-on-change, optional-file, and exception-wrapping behaviour from FileConfigurationProvider. Override Load(Stream) only. The Parse → Resolve → flatten pipeline is shared with TextStreamConfigurationProvider via Bodu.Extensions.Configuration.Text.TextConfigurationLoader.

Consumers do not construct this type directly - it is materialized by Build(IConfigurationBuilder) when an IConfigurationBuilder is built. The typed TextSource accessor exists for diagnostic scenarios where a host needs to inspect the source that produced a given IConfigurationProvider.

Constructors

TextConfigurationProvider(TextConfigurationSource)

Initializes a new instance of the TextConfigurationProvider class backed by the supplied source.

public TextConfigurationProvider(TextConfigurationSource source)

Parameters

source TextConfigurationSource

The source that produced this provider.

Exceptions

ArgumentNullException

source is null.

Properties

TextSource

Gets the typed source that backs this provider.

public TextConfigurationSource TextSource { get; }

Property Value

TextConfigurationSource

The originating TextConfigurationSource.

Methods

Load(Stream)

Loads this provider's data from a stream.

public override void Load(Stream stream)

Parameters

stream Stream

The stream to read.

Applies to

Product	Versions
.NET	8, 10