TextStreamConfigurationProvider Class

Definition

Namespace

Bodu.Extensions.Configuration.Text

Assembly

Bodu.Extensions.Configuration.Text.dll

Package

Bodu.Extensions.Configuration.Text 1.0.0

Source

TextStreamConfigurationProvider.cs

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

public sealed class TextStreamConfigurationProvider : StreamConfigurationProvider, IConfigurationProvider

Inheritance

object

ConfigurationProvider

StreamConfigurationProvider

TextStreamConfigurationProvider

Implements

IConfigurationProvider

Inherited Members

StreamConfigurationProvider.Load()

StreamConfigurationProvider.Source

ConfigurationProvider.TryGet(string, out string)

ConfigurationProvider.Set(string, string)

ConfigurationProvider.GetChildKeys(IEnumerable<string>, string)

ConfigurationProvider.GetReloadToken()

ConfigurationProvider.ToString()

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 stream provider after the configuration root has been built.
IConfigurationRoot root = builder.Build();
TextStreamConfigurationProvider? bodu = root.Providers
    .OfType<TextStreamConfigurationProvider>()
    .FirstOrDefault();

if (bodu is not null)
{
    Console.WriteLine($"Target path: {bodu.TextSource.TargetPath ?? "<none>"}");
}

Remarks

Stream-backed providers are one-shot: the stream is consumed during the initial Load(Stream) call and no reload-on-change machinery is attached. For file-backed loading with reload support, use TextConfigurationProvider instead. The Parse → Resolve → flatten pipeline is shared with TextConfigurationProvider 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

TextStreamConfigurationProvider(TextStreamConfigurationSource)

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

public TextStreamConfigurationProvider(TextStreamConfigurationSource source)

Parameters

source TextStreamConfigurationSource

The source that produced this provider.

Exceptions

ArgumentNullException

source is null.

Properties

TextSource

Gets the typed source that backs this provider.

public TextStreamConfigurationSource TextSource { get; }

Property Value

TextStreamConfigurationSource

The originating TextStreamConfigurationSource.

Methods

Load(Stream)

Loads the configuration data from the stream.

public override void Load(Stream stream)

Parameters

stream Stream

The data stream.

Applies to

Product	Versions
.NET	8, 10