DotEnvElement Struct

Definition

Namespace

Bodu.Text.DotEnv.Document

Assembly

Bodu.Text.DotEnv.dll

Package

Bodu.Text.DotEnv 1.0.0

Source

DotEnvElement.cs

Represents a single element - the root object or one of its string values - within a DotEnvDocument, shaped after System.Text.Json's JsonElement.

public readonly struct DotEnvElement

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.Clamp<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.IsBetween<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.IsGreaterThanOrEqual<T>(T, T?, IComparer<T>)

ComparableExtensions.IsGreaterThan<T>(T, T?, IComparer<T>)

ComparableExtensions.IsLessThanOrEqual<T>(T, T?, IComparer<T>)

ComparableExtensions.IsLessThan<T>(T, T?, IComparer<T>)

ComparableExtensions.IsOutside<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Properties

ValueKind

Gets the value kind of this element.

public DotEnvValueKind ValueKind { get; }

Property Value

DotEnvValueKind

Object for the root; otherwise String.

Methods

EnumerateObject()

Enumerates the properties of an object element in source order.

public DotEnvElement.ObjectEnumerator EnumerateObject()

Returns

DotEnvElement.ObjectEnumerator

An enumerator over the object's properties.

Exceptions

InvalidOperationException

Thrown when this element is not an object.

ObjectDisposedException

Thrown when the owning document has been disposed.

GetProperty(string)

Gets the value element for the specified property name.

public DotEnvElement GetProperty(string name)

Parameters

name string

The property name.

Returns

DotEnvElement

The value element.

Exceptions

ArgumentNullException

Thrown when name is null.

InvalidOperationException

Thrown when this element is not an object.

KeyNotFoundException

Thrown when the property is not present.

ObjectDisposedException

Thrown when the owning document has been disposed.

GetString()

Gets the string value of a String element.

public string GetString()

Returns

string

The string value.

Exceptions

InvalidOperationException

Thrown when this element is not a string.

ObjectDisposedException

Thrown when the owning document has been disposed.

TryGetProperty(string, out DotEnvElement)

Attempts to get the value element for the specified property name.

public bool TryGetProperty(string name, out DotEnvElement value)

Parameters

name string

The property name.

value DotEnvElement

When this method returns true, the value element; otherwise the default element.

Returns

bool

true when the property is present; otherwise false.

Exceptions

ArgumentNullException

Thrown when name is null.

InvalidOperationException

Thrown when this element is not an object.

ObjectDisposedException

Thrown when the owning document has been disposed.

Applies to

Product	Versions
.NET	8, 10