TomlArray Class

Namespace: Meziantou.Framework.Toml.Model
Assembly: Meziantou.Framework.Toml.dll
Package: Meziantou.Framework.Toml 1.0.4
Source: TomlArray.cs
Available in package assets: net10.0net11.0

Runtime representation of a TOML array

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

Inheritance

TomlObject TomlArray

Implements

Constructors

Name	Description
TomlArray()	Initializes a new empty TOML array.
TomlArray(int)	Initializes a new TOML array with the specified capacity.

TomlArray overloads

TomlArray()

TomlArray.cs

Initializes a new empty TOML array.

public TomlArray()

TomlArray(int)

TomlArray.cs

Initializes a new TOML array with the specified capacity.

public TomlArray(int capacity)

Parameters

capacity int: The initial capacity.

Properties

Name	Description
Count	Gets the number of elements contained in the `ICollection<T>`.
IsReadOnly	Gets a value indicating whether the `ICollection<T>` is read-only.

Count

TomlArray.cs

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

public int Count { get; }

Property value

int

IsReadOnly

TomlArray.cs

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

public bool IsReadOnly { get; }

Property value

bool

Indexers

Name	Description
this[int]	Gets or sets the element at the specified index.

this[int]

TomlArray.cs

Gets or sets the element at the specified index.

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

Parameters

index int: The zero-based index of the element to get or set.

Property value

object?

Exceptions

ArgumentOutOfRangeException: index is not a valid index in the IList<T>.
NotSupportedException: The property is set and the IList<T> is read-only.

Methods

Name	Description
Add(object?)	Adds an item to the `ICollection<T>`.
Clear()	Removes all items from the `ICollection<T>`.
Contains(object?)	Determines whether the `ICollection<T>` contains a specific value.
CopyTo(object?[], int)	Copies the elements of the `ICollection<T>` to an `Array`, starting at a particular `Array` index.
GetEnumerator()	Returns an enumerator that iterates through the array.
IndexOf(object?)	Determines the index of a specific item in the `IList<T>`.
Insert(int, object?)	Inserts an item to the `IList<T>` at the specified index.
Remove(object?)	Removes the first occurrence of a specific object from the `ICollection<T>`.
RemoveAt(int)	Removes the `IList<T>` item at the specified index.
System.Collections.Generic.IEnumerable<System.Object>.GetEnumerator()
System.Collections.IEnumerable.GetEnumerator()

Add(object?)

TomlArray.cs

Adds an item to the ICollection<T>.

public void Add(object? item)

Parameters

item object?: The object to add to the ICollection<T>.

Exceptions

NotSupportedException: The ICollection<T> is read-only.

Clear()

TomlArray.cs

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

NotSupportedException: The ICollection<T> is read-only.

Contains(object?)

TomlArray.cs

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

public bool Contains(object? item)

Parameters

item object?: The object to locate in the ICollection<T>.

Returns

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

CopyTo(object?[], int)

TomlArray.cs

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

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

Parameters

array object?[]: 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.

GetEnumerator()

TomlArray.cs

Returns an enumerator that iterates through the array.

public List<object?>.Enumerator GetEnumerator()

Returns

List<object?>.Enumerator An enumerator for the array.

IndexOf(object?)

TomlArray.cs

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

public int IndexOf(object? item)

Parameters

item object?: The object to locate in the IList<T>.

Returns

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

Insert(int, object?)

TomlArray.cs

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

public void Insert(int index, object? item)

Parameters

index int: The zero-based index at which item should be inserted.
item object?: 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(object?)

TomlArray.cs

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

public bool Remove(object? item)

Parameters

item object?: 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)

TomlArray.cs

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.

System.Collections.Generic.IEnumerable<System.Object>.GetEnumerator()

TomlArray.cs

IEnumerator<object?> IEnumerable<object>.GetEnumerator()

Returns

IEnumerator<object?>

No documentation is available.

System.Collections.IEnumerable.GetEnumerator()

TomlArray.cs

IEnumerator IEnumerable.GetEnumerator()

Returns

IEnumerator

No documentation is available.