ConfigurationParseResult Class

Definition

Namespace

Bodu.Text.Configuration

Assembly

Bodu.Text.Configuration.dll

Package

Bodu.Text.Configuration 1.0.0

Source

ConfigurationParseResult.cs

Carries the outcome of a configuration parse: the populated ConfigurationDocument and any diagnostics collected during the parse.

public sealed class ConfigurationParseResult

Inheritance

object

ConfigurationParseResult

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

Under Throw the parser raises ConfigurationParseException on the first recoverable error, so a returned ConfigurationParseResult from ParseWithDiagnostics(string, ConfigurationParseOptions?) always represents a successful parse whose diagnostic list is empty. Under Collect the parser runs to completion and the diagnostic list reflects every recoverable error and warning encountered.

Constructors

ConfigurationParseResult(ConfigurationDocument, ImmutableArray<ConfigurationDiagnostic>)

Initializes a new instance of the ConfigurationParseResult class.

public ConfigurationParseResult(ConfigurationDocument document, ImmutableArray<ConfigurationDiagnostic> diagnostics)

Parameters

document ConfigurationDocument

The parsed document.

diagnostics ImmutableArray<ConfigurationDiagnostic>

The diagnostics collected during the parse.

Exceptions

ArgumentNullException

document is null.

Properties

Diagnostics

Gets the diagnostics collected during the parse.

public ImmutableArray<ConfigurationDiagnostic> Diagnostics { get; }

Property Value

ImmutableArray<ConfigurationDiagnostic>

An immutable, possibly empty array of diagnostics.

Document

Gets the parsed document.

public ConfigurationDocument Document { get; }

Property Value

ConfigurationDocument

A populated ConfigurationDocument.

Applies to

Product	Versions
.NET	8, 10