TextStreamConfigurationSource Class

Definition

Namespace: Bodu.Extensions.Configuration.Text

Assembly: Bodu.Extensions.Configuration.Text.dll

Package: Bodu.Extensions.Configuration.Text 1.0.0

Source: TextStreamConfigurationSource.cs

A StreamConfigurationSource that reads a Bodu Text Configuration document from an arbitrary Stream and projects its resolved view into the IConfiguration hierarchy as colon-delimited keys.

public sealed class TextStreamConfigurationSource : StreamConfigurationSource, IConfigurationSource

Inheritance: object

StreamConfigurationSource

TextStreamConfigurationSource

Implements: IConfigurationSource

Inherited Members: StreamConfigurationSource.Stream

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

Examples

// Test-time configuration from an in-memory string.
const string ConfigText = """
    [*]
    Logging:Level = Debug

    [src/**/*.cs]
    format:indent:size = 4
    """;

using var stream = new MemoryStream(Encoding.UTF8.GetBytes(ConfigText));

IConfigurationRoot root = new ConfigurationBuilder()
    .AddTextConfigurationStream(source =>
    {
        source.Stream     = stream;
        source.TargetPath = "src/Foo.cs";
    })
    .Build();

Console.WriteLine(root["Logging:Level"]);          // "Debug"
Console.WriteLine(root["format:indent:size"]);     // "4"

Remarks

Mirrors the role of JsonStreamConfigurationSource in Microsoft.Extensions.Configuration.Json. Unlike TextConfigurationSource (which is file-backed and inherits reload-on-change), this source is one-shot: the stream is parsed once when Build(IConfigurationBuilder) is invoked and no file watcher is attached. The caller is responsible for the stream's lifetime; the provider does not dispose it.

Use this shape when the configuration text lives somewhere other than the file system - embedded resources, in-memory test inputs, content downloaded from a config service, or content authored by another part of the host process. TargetPath, ParseOptions, and ResolveOptions behave the same way as on the file-backed source.

Constructors