Class IDictionaryExtensions

Namespace

Songhay.Extensions

Assembly

SonghayCore.dll

Extensions of IDictionary<TKey, TValue>.

public static class IDictionaryExtensions

Inheritance

object

IDictionaryExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ToNameValueCollection<TKey, TValue>(IDictionary<TKey, TValue>?)

Converts the IDictionary<TKey, TValue> to the NameValueCollection.

public static NameValueCollection ToNameValueCollection<TKey, TValue>(this IDictionary<TKey, TValue>? dictionary)

Parameters

dictionary IDictionary<TKey, TValue>

The set.

Returns

NameValueCollection

Type Parameters

TKey

The type of the key.

TValue

The type of the value.

Remarks

For detail, see https://stackoverflow.com/a/7230446/22944

ToShallowClone<TKey, TValue>(IDictionary<TKey, TValue>?)

Converts the IDictionary<TKey, TValue> to a shallow clone.

public static IDictionary<TKey, TValue> ToShallowClone<TKey, TValue>(this IDictionary<TKey, TValue>? dictionary) where TKey : notnull

Parameters

dictionary IDictionary<TKey, TValue>

the IDictionary<TKey, TValue>

Returns

IDictionary<TKey, TValue>

Type Parameters

TKey

The type of the key.

TValue

The type of the value.

Remarks

For more detail see “Clone a Dictionary in C#” [https://www.techiedelight.com/clone-a-dictionary-in-csharp/]

ToUriQueryString<TKey, TValue>(IDictionary<TKey, TValue?>?)

Converts the specified dictionary into a Query string.

public static string ToUriQueryString<TKey, TValue>(this IDictionary<TKey, TValue?>? dictionary)

Parameters

dictionary IDictionary<TKey, TValue>

the IDictionary<TKey, TValue>

Returns

string

Type Parameters

TKey

The type of the key.

TValue

The type of the value.

Remarks

No URI encoding logic is used by this method.

TryGetValueWithKey<TKey, TValue>(IDictionary<TKey, TValue>?, TKey)

Tries to get value with the specified key.

public static TValue? TryGetValueWithKey<TKey, TValue>(this IDictionary<TKey, TValue>? dictionary, TKey key)

Parameters

dictionary IDictionary<TKey, TValue>

The dictionary.

key TKey

The key.

Returns

TValue

Type Parameters

TKey

The type of the key.

TValue

The type of the value.

TryGetValueWithKey<TKey, TValue>(IDictionary<TKey, TValue>?, TKey?, bool)

Tries to get value with the specified key.

public static TValue? TryGetValueWithKey<TKey, TValue>(this IDictionary<TKey, TValue>? dictionary, TKey? key, bool throwException)

Parameters

dictionary IDictionary<TKey, TValue>

The dictionary.

key TKey

The key.

throwException bool

When true, throw an exception when retrieval fails.

Returns

TValue

Type Parameters

TKey

The type of the key.

TValue

The type of the value.

UnionAsDictionary<TKey, TValue>(IDictionary<TKey, TValue?>?, IDictionary<TKey, TValue?>?)

Invokes the Union<TSource>(IEnumerable<TSource>, IEnumerable<TSource>) method with the specified dictionaries and calls ToDictionary<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>>) on the result.

public static IDictionary<TKey, TValue?>? UnionAsDictionary<TKey, TValue>(this IDictionary<TKey, TValue?>? dictionary1, IDictionary<TKey, TValue?>? dictionary2) where TKey : notnull

Parameters

dictionary1 IDictionary<TKey, TValue>

dictionary2 IDictionary<TKey, TValue>

Returns

IDictionary<TKey, TValue>

Type Parameters

TKey

The type of the key.

TValue

The type of the value.

Remarks

When Union<TSource>(IEnumerable<TSource>, IEnumerable<TSource>) is called .NET returns a collection of KeyValuePair<TKey, TValue> to avoid losing dictionary entries with the same key. This member disregards this danger and ensures a dictionary is returned.

WithPair<TKey, TValue>(IDictionary<TKey, TValue?>?, KeyValuePair<TKey, TValue?>?)

Returns the IDictionary<TKey, TValue> with the specified pair.

public static IDictionary<TKey, TValue?>? WithPair<TKey, TValue>(this IDictionary<TKey, TValue?>? dictionary, KeyValuePair<TKey, TValue?>? pair) where TKey : notnull

Parameters

dictionary IDictionary<TKey, TValue>

the IDictionary<TKey, TValue>

pair KeyValuePair<TKey, TValue>?

the KeyValuePair<TKey, TValue>

Returns

IDictionary<TKey, TValue>

Type Parameters

TKey

The type of the key.

TValue

The type of the value.

WithPair<TKey, TValue>(IDictionary<TKey, TValue?>?, TKey?, TValue?)

Returns the IDictionary<TKey, TValue> with the specified pair.

public static IDictionary<TKey, TValue?>? WithPair<TKey, TValue>(this IDictionary<TKey, TValue?>? dictionary, TKey? key, TValue? value) where TKey : notnull

Parameters

dictionary IDictionary<TKey, TValue>

the IDictionary<TKey, TValue>

key TKey

the key

value TValue

the value

Returns

IDictionary<TKey, TValue>

Type Parameters

TKey

The type of the key.

TValue

The type of the value.

WithPair<TKey, TValue>(IDictionary<TKey, TValue?>?, TKey?, TValue?, Func<bool>?)

Returns the IDictionary<TKey, TValue> with the specified pair.

public static IDictionary<TKey, TValue?>? WithPair<TKey, TValue>(this IDictionary<TKey, TValue?>? dictionary, TKey? key, TValue? value, Func<bool>? condition) where TKey : notnull

Parameters

dictionary IDictionary<TKey, TValue>

the IDictionary<TKey, TValue>

key TKey

the key

value TValue

the value

condition Func<bool>

The condition.

Returns

IDictionary<TKey, TValue>

Type Parameters

TKey

The type of the key.

TValue

The type of the value.

WithPairs<TKey, TValue>(IDictionary<TKey, TValue?>?, IEnumerable<KeyValuePair<TKey, TValue?>>?)

Returns the IDictionary<TKey, TValue> with the specified pairs.

public static IDictionary<TKey, TValue?>? WithPairs<TKey, TValue>(this IDictionary<TKey, TValue?>? dictionary, IEnumerable<KeyValuePair<TKey, TValue?>>? pairs) where TKey : notnull

Parameters

dictionary IDictionary<TKey, TValue>

the IDictionary<TKey, TValue>

pairs IEnumerable<KeyValuePair<TKey, TValue>>

The pairs to add.

Returns

IDictionary<TKey, TValue>

Type Parameters

TKey

The type of the key.

TValue

The type of the value.