TomlArray Class

Definition

Namespace

Bodu.Text.Toml.Nodes

Assembly

Bodu.Text.Toml.dll

Package

Bodu.Text.Toml 1.0.0

Source

TomlArray.cs

Represents a mutable TOML array as an ordered, index-addressable collection of child nodes.

public sealed class TomlArray : TomlNode, IList<TomlNode?>, ICollection<TomlNode?>, IEnumerable<TomlNode?>, IEnumerable

Inheritance

object

TomlNode

TomlArray

Implements

IList<TomlNode>

ICollection<TomlNode>

IEnumerable<TomlNode>

IEnumerable

Inherited Members

TomlNode.AsObject()

TomlNode.AsArray()

TomlNode.AsValue()

TomlNode.GetValue<T>()

TomlNode.ToUtf8Bytes()

TomlNode.Parse(ReadOnlySpan<byte>)

TomlNode.Parse(ReadOnlySpan<byte>, TomlNodeOptions)

TomlNode.DeepEquals(TomlNode, TomlNode)

TomlNode.Parent

TomlNode.Root

TomlNode.this[string]

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

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

Elements are kept in insertion order, which is also the order in which they are serialized. An element may be null in memory, but an array containing a null element cannot be written because TOML has no null token. Adding a node that already belongs to another container throws an InvalidOperationException; removing or replacing an element detaches it, clearing its Parent so it can be added to another container.

var tags = new TomlArray(TomlValue.Create("a"), TomlValue.Create("b"));
tags.Add(TomlValue.Create("c"));

var root = new TomlObject { ["tags"] = tags };
byte[] utf8 = root.ToUtf8Bytes();   // tags = [ "a", "b", "c" ]

Constructors

TomlArray()

Initializes a new instance of the TomlArray class that is empty.

public TomlArray()

TomlArray(params TomlNode?[])

Initializes a new instance of the TomlArray class containing the supplied items in order.

public TomlArray(params TomlNode?[] items)

Parameters

items TomlNode[]

The initial elements.

Exceptions

ArgumentNullException

Thrown when items is null.

InvalidOperationException

Thrown when an element already belongs to another container.

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int

The number of elements contained in the ICollection<T>.

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

public bool IsReadOnly { get; }

Property Value

bool

true if the ICollection<T> is read-only; otherwise, false.

this[int]

Gets or sets the element at the specified index.

public TomlNode? this[int index] { get; set; }

Parameters

index int

The zero-based index of the element.

Property Value

TomlNode

The element at index.

Remarks

Assigning over an existing element detaches the replaced node, clearing its Parent.

Exceptions

ArgumentOutOfRangeException

Thrown when index is outside the bounds of the list.

InvalidOperationException

Thrown when the assigned node already belongs to another container.

Methods

Add(TomlNode?)

Adds an item to the ICollection<T>.

public void Add(TomlNode? item)

Parameters

item TomlNode

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Contains(TomlNode?)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(TomlNode? item)

Parameters

item TomlNode

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(TomlNode?[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(TomlNode?[] array, int arrayIndex)

Parameters

array TomlNode[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

DeepClone()

Creates a deep copy of this node and its entire subtree.

public override TomlNode DeepClone()

Returns

TomlNode

An independent clone with no parent.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<TomlNode?> GetEnumerator()

Returns

IEnumerator<TomlNode>

An enumerator that can be used to iterate through the collection.

GetValueKind()

Gets the kind of value this node represents.

public override TomlValueKind GetValueKind()

Returns

TomlValueKind

The TomlValueKind of this node.

IndexOf(TomlNode?)

Determines the index of a specific item in the IList<T>.

public int IndexOf(TomlNode? item)

Parameters

item TomlNode

The object to locate in the IList<T>.

Returns

int

The index of item if found in the list; otherwise, -1.

Insert(int, TomlNode?)

Inserts an item to the IList<T> at the specified index.

public void Insert(int index, TomlNode? item)

Parameters

index int

The zero-based index at which item should be inserted.

item TomlNode

The object to insert into the IList<T>.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

Remove(TomlNode?)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(TomlNode? item)

Parameters

item TomlNode

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

RemoveAt(int)

Removes the IList<T> item at the specified index.

public void RemoveAt(int index)

Parameters

index int

The zero-based index of the item to remove.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

ToString()

Returns a string representation of this node.

public override string ToString()

Returns

string

A textual rendering of this node.

WriteTo(Utf8TomlWriter)

Writes the normalized TOML encoding of this node to the supplied writer.

public override void WriteTo(Utf8TomlWriter writer)

Parameters

writer Utf8TomlWriter

The destination writer.

Remarks

Because a TOML document's root must be a table, the writer produces a document only when the outermost node is a TomlObject. Writing a node whose root is a scalar or array yields no document; use ToUtf8Bytes() to obtain the normalized bytes, which validates the table-root rule.

Exceptions

TomlSerializationException

Thrown when the subtree rooted at this node contains a null entry, which has no TOML representation.

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerator? IEnumerable.GetEnumerator()

Returns

IEnumerator

An IEnumerator object that can be used to iterate through the collection.

Applies to

Product	Versions
.NET	8, 10