EqualityMap<K, V> class

A Map whose key equality is determined by an Equality object.

Inheritance

• Object
• DelegatingMap<K, V>
• EqualityMap

Available extensions

• MapExt
• MapOfOptions
• MapOfResults

Constructors

EqualityMap(Equality<K> equality)

Creates a map with equality based on equality.

EqualityMap.from(Equality<K> equality, Map<K, V> other)

Creates a map with equality based on equality that contains all key-value pairs of other.

Properties

entries → Iterable<MapEntry<K, V>>

The map entries of this Map.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isEmpty → bool

Whether there is no key/value pair in the map.

no setter, inherited

isNotEmpty → bool

Whether there is at least one key/value pair in the map.

no setter, inherited

keys → Iterable<K>

The keys of this Map.

no setter, inherited

length → int

The number of key/value pairs in the map.

no setter, inherited

noneIfEmpty → Option<Map<K, V>>

Available on Map<K, V>, provided by the MapExt extension

Returns this map wrapped in a Some if it's not empty, otherwise returns None.

no setter

okValues → Map<K, V>

Available on Map<K, Result<V>>, provided by the MapOfResults extension

Returns a new map containing only the unwrapped values from Ok entries.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

someValues → Map<K, V>

Available on Map<K, Option<V>>, provided by the MapOfOptions extension

Returns a new map containing only the unwrapped values from Some entries.

no setter

values → Iterable<V>

The values of this Map.

no setter, inherited

Methods

addAll(Map<K, V> other) → void

Adds all key/value pairs of other to this map.

inherited

addEntries(Iterable<MapEntry<K, V>> entries) → void

Adds all key/value pairs of newEntries to this map.

inherited

cast<K2, V2>() → Map<K2, V2>

Provides a view of this map as having RK keys and RV instances, if necessary.

inherited

clear() → void

Removes all entries from the map.

inherited

containsKey(Object? key) → bool

Whether this map contains the given key.

inherited

containsValue(Object? value) → bool

Whether this map contains the given value.

inherited

forEach(void f(K, V)) → void

Applies action to each key/value pair of the map.

inherited

getOption(K key) → Option<V>

Available on Map<K, V>, provided by the MapExt extension

Safely gets the value for a given key, returning an Option.

map<K2, V2>(MapEntry<K2, V2> transform(K, V)) → Map<K2, V2>

Returns a new map where all entries of this map are transformed by the given convert function.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

partition() → MapOptionPartition<K, V>

Available on Map<K, Option<V>>, provided by the MapOfOptions extension

Partitions the map into a record containing two maps: one for Some values and one for None values.

partition() → MapResultPartition<K, V>

Available on Map<K, Result<V>>, provided by the MapOfResults extension

Partitions the map into a record containing two maps: one for Ok values and one for Err values.

putIfAbsent(K key, V ifAbsent()) → V

Look up the value of key, or add a new entry if it isn't there.

inherited

remove(Object? key) → V?

Removes key and its associated value, if present, from the map.

inherited

removeWhere(bool test(K, V)) → void

Removes all entries of this map that satisfy the given test.

inherited

retype<K2, V2>() → Map<K2, V2>

inherited

sequence() → Option<Map<K, V>>

Available on Map<K, Option<V>>, provided by the MapOfOptions extension

Turns a Map<K, Option<V>> into an Option<Map<K, V>>. If all values are Some, it returns a Some<Map<K, V>>. If any value is a None, it returns None.

sequence() → Result<Map<K, V>>

Available on Map<K, Result<V>>, provided by the MapOfResults extension

Turns a Map<K, Result<V>> into a Result<Map<K, V>>. If all values are Ok, it returns an Ok<Map<K, V>>. If any value is an Err, it returns the first Err encountered.

toString() → String

A string representation of this object.

inherited

update(K key, V update(V), {V ifAbsent()?}) → V

Updates the value for the provided key.

inherited

updateAll(V update(K, V)) → void

Updates all values.

inherited

whereErr() → Map<K, Err<V>>

Available on Map<K, Result<V>>, provided by the MapOfResults extension

Creates a new map containing only the entries where the value is an Err. The values in the new map are instances of Err<V>.

whereNone() → Map<K, None<V>>

Available on Map<K, Option<V>>, provided by the MapOfOptions extension

Creates a new map containing only the entries where the value is a None.

whereOk() → Map<K, Ok<V>>

Available on Map<K, Result<V>>, provided by the MapOfResults extension

Creates a new map containing only the entries where the value is an Ok. The values in the new map are instances of Ok<V>.

whereSome() → Map<K, Some<V>>

Available on Map<K, Option<V>>, provided by the MapOfOptions extension

Creates a new map containing only the entries where the value is a Some. The values in the new map are instances of Some<V>.

Operators

operator ==(Object other) → bool

The equality operator.

inherited

operator [](Object? key) → V?

The value for the given key, or null if key is not in the map.

inherited

operator []=(K key, V value) → void

Associates the key with the given value.

inherited