TomlConfigurationSource Class

Definition

Namespace

Bodu.Extensions.Configuration.Text

Assembly

Bodu.Extensions.Configuration.Text.dll

Package

Bodu.Extensions.Configuration.Text 1.0.0

Source

TomlConfigurationSource.cs

Represents a TOML configuration source - either a one-shot Stream or a file path - that produces a read-only TomlConfigurationProvider.

public sealed class TomlConfigurationSource : IConfigurationSource

Inheritance

object

TomlConfigurationSource

Implements

IConfigurationSource

Inherited Members

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

Remarks

The source is read once when the configuration is built; it attaches no reload-on-change machinery. Exactly one of Stream or Path should be set.

// Normally added through the extension method:
IConfiguration configuration = new ConfigurationBuilder()
    .AddTomlFile("appsettings.toml", optional: true)
    .Build();

// The source itself is the seam for custom composition:
var source = new TomlConfigurationSource { Path = "appsettings.toml", Optional = true };

Constructors

TomlConfigurationSource()

public TomlConfigurationSource()

Properties

Optional

Gets or sets a value indicating whether a missing file at Path is permitted.

public bool Optional { get; set; }

Property Value

bool

true when the file may be absent; otherwise false.

Path

Gets or sets the path of the TOML file to read.

public string? Path { get; set; }

Property Value

string

The configured file path, or null when the source is stream-backed.

Stream

Gets or sets the stream containing UTF-8 TOML text. Takes precedence over Path when both are set.

public Stream? Stream { get; set; }

Property Value

Stream

The configured stream, or null when the source is file-backed.

Methods

Build(IConfigurationBuilder)

Builds the read-only provider for this source.

public IConfigurationProvider Build(IConfigurationBuilder builder)

Parameters

builder IConfigurationBuilder

The configuration builder.

Returns

IConfigurationProvider

A TomlConfigurationProvider.

Applies to

Product	Versions
.NET	8, 10