Struct ReadOnlyArray<T>

Namespace

LfrlAnvil

Assembly

LfrlAnvil.Core.dll

A lightweight generic read-only container for an Array.

public readonly struct ReadOnlyArray<T> : IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable

Type Parameters

T

Implements

IReadOnlyList<T>

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

ReadOnlyArray(T[])

Creates a new ReadOnlyArray<T> instance.

public ReadOnlyArray(T[] source)

Parameters

source T[]

Underlying Array.

Fields

Empty

Represents a empty read-only Array.

public static readonly ReadOnlyArray<T> Empty

Field Value

ReadOnlyArray<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.

this[int]

Gets the element at the specified index in the read-only list.

public T this[int index] { get; }

Parameters

index int

The zero-based index of the element to get.

Property Value

T

The element at the specified index in the read-only list.

Methods

AsMemory()

Creates a new ReadOnlyMemory<T> instance from this ReadOnlyArray<T>.

[Pure]
public ReadOnlyMemory<T> AsMemory()

Returns

ReadOnlyMemory<T>

New ReadOnlyMemory<T> instance.

AsSpan()

Creates a new ReadOnlySpan<T> instance from this ReadOnlyArray<T>.

[Pure]
public ReadOnlySpan<T> AsSpan()

Returns

ReadOnlySpan<T>

New ReadOnlySpan<T> instance.

From<TSource>(ReadOnlyArray<TSource>)

Creates a new ReadOnlyArray<T> instance.

[Pure]
public static ReadOnlyArray<T> From<TSource>(ReadOnlyArray<TSource> source) where TSource : class?, T

Parameters

source ReadOnlyArray<TSource>

Other read-only array.

Returns

ReadOnlyArray<T>

New ReadOnlyArray<T> instance.

Type Parameters

TSource

Array element type convertible to read-only array's element type.

From<TSource>(TSource[])

Creates a new ReadOnlyArray<T> instance.

[Pure]
public static ReadOnlyArray<T> From<TSource>(TSource[] source) where TSource : class?, T

Parameters

source TSource[]

Underlying array.

Returns

ReadOnlyArray<T>

New ReadOnlyArray<T> instance.

Type Parameters

TSource

Array element type convertible to read-only array's element type.

GetEnumerator()

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

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

Returns

ReadOnlyArray<T>.Enumerator

New ReadOnlyArray<T>.Enumerator instance.

GetUnderlyingArray()

Returns the underlying array.

[Pure]
public IReadOnlyList<T> GetUnderlyingArray()

Returns

IReadOnlyList<T>

The underlying array.

Operators

implicit operator ReadOnlyArray<T>(T[])

Converts the provided source to ReadOnlyArray<T>.

[Pure]
public static implicit operator ReadOnlyArray<T>(T[] source)

Parameters

source T[]

Underlying array.

Returns

ReadOnlyArray<T>

New ReadOnlyArray<T> instance.