TextConfigurationSource Class

Definition

Namespace: Bodu.Extensions.Configuration.Text

Assembly: Bodu.Extensions.Configuration.Text.dll

Package: Bodu.Extensions.Configuration.Text 1.0.0

Source: TextConfigurationSource.cs

A FileConfigurationSource that reads a Bodu Text Configuration file and projects its resolved view into the IConfiguration hierarchy as colon-delimited keys.

public sealed class TextConfigurationSource : FileConfigurationSource, IConfigurationSource

Inheritance: object

FileConfigurationSource

TextConfigurationSource

Implements: IConfigurationSource

Inherited Members: FileConfigurationSource.EnsureDefaults(IConfigurationBuilder)

FileConfigurationSource.ResolveFileProvider()

FileConfigurationSource.FileProvider

FileConfigurationSource.Path

FileConfigurationSource.Optional

FileConfigurationSource.ReloadOnChange

FileConfigurationSource.ReloadDelay

FileConfigurationSource.OnLoadException

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

// Typical lambda registration via the IConfigurationBuilder extension.
builder.Configuration.AddTextConfigurationFile(source =>
{
    source.Path           = "app.boduconfig";
    source.TargetPath     = "src/Web/Startup.cs"; // anchors glob sections like [src/**/*.cs]
    source.Optional       = false;
    source.ReloadOnChange = true;
    source.ParseOptions   = ConfigurationParseOptions.Strict;
});

// Direct construction - for example, in a custom builder host.
var source = new TextConfigurationSource
{
    Path           = "app.boduconfig",
    ReloadOnChange = true,
    TargetPath     = "src/Web/Startup.cs",
};
IConfigurationProvider provider = source.Build(builder);

Remarks

Inherits the standard reload-on-change, file-provider, and optional-file behaviours from FileConfigurationSource, matching the conventions used by the JSON, INI, and XML providers shipped by Microsoft. Three Bodu-specific properties extend the base contract: TargetPath drives glob-anchored section matching during resolution, ParseOptions controls how the document is read, and ResolveOptions controls how the resolved view is layered.

Most callers do not construct this type directly; reach for the AddTextConfigurationFile(IConfigurationBuilder, string, string?, bool, bool) extensions instead. Direct construction is appropriate when a host already has the source instance in hand - for example, when wiring a custom IConfigurationBuilder programmatically.

Constructors