Interface ICache<TKey, TValue>

Namespace

LfrlAnvil.Caching

Assembly

LfrlAnvil.Core.dll

Represents a generic cache of keyed entries.

public interface ICache<TKey, TValue> : IReadOnlyCache<TKey, TValue>, IReadOnlyDictionary<TKey, TValue>, IReadOnlyCollection<KeyValuePair<TKey, TValue>>, IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable where TKey : notnull

Type Parameters

TKey

Entry key (identifier) type.

TValue

Entry value type.

Inherited Members

IReadOnlyCache<TKey, TValue>.Capacity

IReadOnlyCache<TKey, TValue>.Comparer

IReadOnlyCache<TKey, TValue>.Oldest

IReadOnlyDictionary<TKey, TValue>.ContainsKey(TKey)

IReadOnlyDictionary<TKey, TValue>.TryGetValue(TKey, out TValue)

IReadOnlyDictionary<TKey, TValue>.this[TKey]

IReadOnlyDictionary<TKey, TValue>.Keys

IReadOnlyDictionary<TKey, TValue>.Values

IReadOnlyCollection<KeyValuePair<TKey, TValue>>.Count

IEnumerable<KeyValuePair<TKey, TValue>>.GetEnumerator()

IEnumerable.GetEnumerator()

Extension Methods

CollectionExtensions.GetOrAddAsync<TKey, TValue>(ICache<TKey, TValue>, TKey, Func<TKey, CancellationToken, Task<TValue>>, CancellationToken)

CollectionExtensions.GetOrAddAsync<TKey, TValue>(ICache<TKey, TValue>, TKey, Func<TKey, CancellationToken, ValueTask<TValue>>, CancellationToken)

CollectionExtensions.GetOrAdd<TKey, TValue>(ICache<TKey, TValue>, TKey, Func<TKey, TValue>)

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

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?>)

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

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

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

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

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>?)

Properties

this[TKey]

Gets or sets the entry that has the specified key.

TValue this[TKey key] { get; set; }

Parameters

key TKey

The key of the entry to get or set.

Property Value

TValue

Remarks

See AddOrUpdate(TKey, TValue) for more information about the setter's behavior.

Exceptions

KeyNotFoundException

Entry with the provided key does not exist.

Methods

AddOrUpdate(TKey, TValue)

Adds a new entry or updates an existing one if key already exists.

AddOrUpdateResult AddOrUpdate(TKey key, TValue value)

Parameters

key TKey

Entry's key.

value TValue

Entry's value.

Returns

AddOrUpdateResult

Added when new entry has been added (provided key did not exist), otherwise Updated.

Remarks

When new entry addition causes Count to exceed Capacity, then the Oldest entry will be removed automatically.

Clear()

Removes all entries from the collection.

void Clear()

Remove(TKey)

Attempts to remove an entry with the specified key.

bool Remove(TKey key)

Parameters

key TKey

Key of an entry to remove.

Returns

bool

true when entry has been removed, otherwise false.

Remove(TKey, out TValue)

Attempts to remove an entry with the specified key and to return a value associated with that key.

bool Remove(TKey key, out TValue removed)

Parameters

key TKey

Key of an entry to remove.

removed TValue

An out parameter that returns a value associated with the key, if it exists.

Returns

bool

true when entry has been removed, otherwise false.

Restart(TKey)

Attempts to restart an entry associated with the specified key by e.g. moving it to the top of the cache.

bool Restart(TKey key)

Parameters

key TKey

Key of an entry to restart.

Returns

bool

true when entry has been restarted (provided key exists), otherwise false.

TryAdd(TKey, TValue)

Attempts to add a new entry.

bool TryAdd(TKey key, TValue value)

Parameters

key TKey

Entry's key.

value TValue

Entry's value.

Returns

bool

true when entry has been added (provided key did not exist), otherwise false.

Remarks

When new entry addition causes Count to exceed Capacity, then the Oldest entry will be removed automatically.