Struct Chain<T>

Namespace

LfrlAnvil

Assembly

LfrlAnvil.Core.dll

A lightweight representation of a sequence of linked nodes with values.

public readonly struct Chain<T> : IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable

Type Parameters

T

Value type.

Implements

IReadOnlyCollection<T>

IEnumerable<T>

IEnumerable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ObjectExtensions.Memoize<T1, T2>(T1, Func<T1, IEnumerable<T2>>)

ObjectExtensions.ToNullable<T>(T)

ObjectExtensions.ToRef<T>(T)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitWithSelf<T>(T, Func<T, T>, Func<T, bool>)

ObjectExtensions.Visit<T>(T, Func<T, T>, Func<T, bool>)

EnumerableExtensions.ContainsAtLeast<T>(IEnumerable<T>, int)

EnumerableExtensions.ContainsAtMost<T>(IEnumerable<T>, int)

EnumerableExtensions.ContainsDuplicates<T>(IEnumerable<T>)

EnumerableExtensions.ContainsDuplicates<T>(IEnumerable<T>, IEqualityComparer<T>)

EnumerableExtensions.ContainsExactly<T>(IEnumerable<T>, int)

EnumerableExtensions.ContainsInRange<T>(IEnumerable<T>, int, int)

EnumerableExtensions.ContainsNull<T>(IEnumerable<T>, IEqualityComparer<T>)

EnumerableExtensions.EmptyIfNull<T>(IEnumerable<T>?)

EnumerableExtensions.Flatten<T1, T2>(IEnumerable<T1>, Func<T1, IEnumerable<T2>>)

EnumerableExtensions.Flatten<T1, T2, TResult>(IEnumerable<T1>, Func<T1, IEnumerable<T2>>, Func<T1, T2, TResult>)

EnumerableExtensions.FullJoin<T1, T2, TKey, TResult>(IEnumerable<T1>, IEnumerable<T2>, Func<T1, TKey>, Func<T2, TKey>, Func<T1?, T2?, TResult>)

EnumerableExtensions.FullJoin<T1, T2, TKey, TResult>(IEnumerable<T1>, IEnumerable<T2>, Func<T1, TKey>, Func<T2, TKey>, Func<T1?, T2?, TResult>, IEqualityComparer<TKey>)

EnumerableExtensions.IsEmpty<T>(IEnumerable<T>)

EnumerableExtensions.IsMaterialized<T>(IEnumerable<T>)

EnumerableExtensions.IsMemoized<T>(IEnumerable<T>)

EnumerableExtensions.IsNullOrEmpty<T>(IEnumerable<T>?)

EnumerableExtensions.IsOrdered<T>(IEnumerable<T>)

EnumerableExtensions.IsOrdered<T>(IEnumerable<T>, IComparer<T>)

EnumerableExtensions.LeftJoin<T1, T2, TKey, TResult>(IEnumerable<T1>, IEnumerable<T2>, Func<T1, TKey>, Func<T2, TKey>, Func<T1, T2?, TResult>)

EnumerableExtensions.LeftJoin<T1, T2, TKey, TResult>(IEnumerable<T1>, IEnumerable<T2>, Func<T1, TKey>, Func<T2, TKey>, Func<T1, T2?, TResult>, IEqualityComparer<TKey>)

EnumerableExtensions.Materialize<T>(IEnumerable<T>)

EnumerableExtensions.Memoize<T>(IEnumerable<T>)

EnumerableExtensions.MinMaxBy<T1, T2>(IEnumerable<T1>, Func<T1, T2>)

EnumerableExtensions.MinMaxBy<T1, T2>(IEnumerable<T1>, Func<T1, T2>, IComparer<T2>)

EnumerableExtensions.MinMaxBy<T1, T2, T3>(IEnumerable<T1>, Func<T1, T2>, Func<T1, T3>)

EnumerableExtensions.MinMaxBy<T1, T2, T3>(IEnumerable<T1>, Func<T1, T2>, Func<T1, T3>, IComparer<T2>, IComparer<T3>)

EnumerableExtensions.MinMax<T>(IEnumerable<T>)

EnumerableExtensions.MinMax<T>(IEnumerable<T>, IComparer<T>)

EnumerableExtensions.Partition<T>(IEnumerable<T>, Func<T, bool>)

EnumerableExtensions.Repeat<T>(IEnumerable<T>, int)

EnumerableExtensions.SetEquals<T>(IEnumerable<T>, IEnumerable<T>)

EnumerableExtensions.SetEquals<T>(IEnumerable<T>, IEnumerable<T>, IEqualityComparer<T>)

EnumerableExtensions.Slice<T>(IEnumerable<T>, int, int)

EnumerableExtensions.ToMemory<T>(IEnumerable<T>)

EnumerableExtensions.TryAggregate<T>(IEnumerable<T>, Func<T, T, T>, out T)

EnumerableExtensions.TryMaxBy<T1, T2>(IEnumerable<T1>, Func<T1, T2>, IComparer<T2>, out T1)

EnumerableExtensions.TryMaxBy<T1, T2>(IEnumerable<T1>, Func<T1, T2>, out T1)

EnumerableExtensions.TryMax<T>(IEnumerable<T>, IComparer<T>, out T)

EnumerableExtensions.TryMax<T>(IEnumerable<T>, out T)

EnumerableExtensions.TryMinBy<T1, T2>(IEnumerable<T1>, Func<T1, T2>, IComparer<T2>, out T1)

EnumerableExtensions.TryMinBy<T1, T2>(IEnumerable<T1>, Func<T1, T2>, out T1)

EnumerableExtensions.TryMinMaxBy<T1, T2>(IEnumerable<T1>, Func<T1, T2>)

EnumerableExtensions.TryMinMaxBy<T1, T2>(IEnumerable<T1>, Func<T1, T2>, IComparer<T2>)

EnumerableExtensions.TryMinMaxBy<T1, T2, T3>(IEnumerable<T1>, Func<T1, T2>, Func<T1, T3>)

EnumerableExtensions.TryMinMaxBy<T1, T2, T3>(IEnumerable<T1>, Func<T1, T2>, Func<T1, T3>, IComparer<T2>, IComparer<T3>)

EnumerableExtensions.TryMinMax<T>(IEnumerable<T>)

EnumerableExtensions.TryMinMax<T>(IEnumerable<T>, IComparer<T>)

EnumerableExtensions.TryMin<T>(IEnumerable<T>, IComparer<T>, out T)

EnumerableExtensions.TryMin<T>(IEnumerable<T>, out T)

EnumerableExtensions.VisitMany<T>(IEnumerable<T>, Func<T, IEnumerable<T>>)

EnumerableExtensions.VisitMany<T>(IEnumerable<T>, Func<T, IEnumerable<T>>, Func<T, bool>)

EnumerableExtensions.WhereNotNull<T>(IEnumerable<T?>, IEqualityComparer<T>)

CollectionExtensions.ContainsAtLeast<T>(IReadOnlyCollection<T>, int)

CollectionExtensions.ContainsAtMost<T>(IReadOnlyCollection<T>, int)

CollectionExtensions.ContainsExactly<T>(IReadOnlyCollection<T>, int)

CollectionExtensions.ContainsInRange<T>(IReadOnlyCollection<T>, int, int)

CollectionExtensions.CopyTo<T>(IReadOnlyCollection<T>, RentedMemorySequenceSpan<T>)

CollectionExtensions.EmptyIfNull<T>(IReadOnlyCollection<T>?)

CollectionExtensions.IsEmpty<T>(IReadOnlyCollection<T>)

CollectionExtensions.IsNullOrEmpty<T>(IReadOnlyCollection<T>?)

Constructors

Chain(Chain<T>)

Creates a new Chain<T> instance from another Chain<T> instance.

public Chain(Chain<T> other)

Parameters

other Chain<T>

Chain<T> instance to copy.

Chain(IEnumerable<T>)

Creates a new Chain<T> instance from a collection of values.

public Chain(IEnumerable<T> values)

Parameters

values IEnumerable<T>

Collection of values.

Chain(T)

Creates a new Chain<T> instance from a single value.

public Chain(T value)

Parameters

value T

Single value.

Fields

Empty

Represents an empty sequence.

public static readonly Chain<T> Empty

Field Value

Chain<T>

Properties

Count

Gets the number of elements in the collection.

public int Count { get; }

Property Value

int

The number of elements in the collection.

IsAttached

Specifies whether or not this sequence has been attached to the end of another sequence.

public bool IsAttached { get; }

Property Value

bool

IsExtendable

Specifies whether or not new values can be appended to this sequence. Chain<T> is considered extendable when it hasn't been attached to the end of another sequence and no value has been added after its last node.

public bool IsExtendable { get; }

Property Value

bool

Methods

Extend(Chain<T>)

Attaches the provided other to the end of this sequence.

[Pure]
public Chain<T> Extend(Chain<T> other)

Parameters

other Chain<T>

Sequence to attach.

Returns

Chain<T>

New Chain<T> instance.

Remarks

This method does not allocate memory.

Exceptions

InvalidOperationException

When this sequence is not extendable.

Extend(IEnumerable<T>)

Adds the provided collection of values to the end of this sequence.

[Pure]
public Chain<T> Extend(IEnumerable<T> values)

Parameters

values IEnumerable<T>

Collection of values to add.

Returns

Chain<T>

New Chain<T> instance.

Exceptions

InvalidOperationException

When this sequence is not extendable.

Extend(T)

Adds the provided value to the end of this sequence.

[Pure]
public Chain<T> Extend(T value)

Parameters

value T

Value to add.

Returns

Chain<T>

New Chain<T> instance.

Exceptions

InvalidOperationException

When this sequence is not extendable.

GetEnumerator()

Creates a new Chain<T>.Enumerator instance for this sequence.

[Pure]
public Chain<T>.Enumerator GetEnumerator()

Returns

Chain<T>.Enumerator

New Chain<T>.Enumerator instance.

ToExtendable()

Returns an extendable version of this Chain<T> instance.

[Pure]
public Chain<T> ToExtendable()

Returns

Chain<T>

This Chain<T> instance or its copy when it's not extendable.