Class DictionaryExtensions

Namespace

LfrlAnvil.Functional.Extensions

Assembly

LfrlAnvil.Functional.dll

Contains dictionary extension methods.

public static class DictionaryExtensions

Inheritance

object

DictionaryExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

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

Attempts to get a value associated with the provided key from the dictionary.

[Pure]
public static Maybe<TValue> TryGetValue<TKey, TValue>(this IReadOnlyDictionary<TKey, TValue> dictionary, TKey key) where TValue : notnull

Parameters

dictionary IReadOnlyDictionary<TKey, TValue>

Source dictionary.

key TKey

Entry's key.

Returns

Maybe<TValue>

New Maybe<T> instance equivalent to value associated with the provided key or None when it does not exist.

Type Parameters

TKey

Key type.

TValue

Value type.

TryRemove<TKey, TValue>(Dictionary<TKey, TValue>, TKey)

Attempts to get remove an entry associated with the provided key from the dictionary.

[Pure]
public static Maybe<TValue> TryRemove<TKey, TValue>(this Dictionary<TKey, TValue> dictionary, TKey key) where TKey : notnull where TValue : notnull

Parameters

dictionary Dictionary<TKey, TValue>

Source dictionary.

key TKey

Entry's key.

Returns

Maybe<TValue>

New Maybe<T> instance equivalent to removed value associated with the provided key or None when it does not exist.

Type Parameters

TKey

Key type.

TValue

Value type.