Moduleaeson-2.2.5.1Haskell2010

Data.Aeson.KeyMap

An abstract interface for maps from JSON keys to values.

Contents

Map Type
Query
Construction
Insertion
Deletion
Update
Combine
Lists
Maps
Traversal
Map
Folds
Conversions
Filter
Key Type

Synopsis

newtype KeyMap
value null
value lookup
value !?
value size
value member
value empty
value singleton
value insert
value insertWith
value delete
value alterF
value difference
value union
value unionWith
value unionWithKey
value intersection
value intersectionWith
value intersectionWithKey
value alignWith
value alignWithKey
value fromList
value fromListWith
value toList
value toAscList
value elems
value fromHashMap
value toHashMap
value fromHashMapText
value toHashMapText
value coercionToHashMap
value fromMap
value toMap
value fromMapText
value toMapText
value coercionToMap
value map
value mapWithKey
value mapKeyVal
value traverse
value traverseWithKey
value foldr
value foldr'
value foldl
value foldl'
value foldMapWithKey
value foldrWithKey
value keys
value filter
value filterWithKey
value mapMaybe
value mapMaybeWithKey
newtype Key

Packageaeson-2.2.5.1
Exports53
LanguageHaskell2010
LicenceBSD-3-Clause
SourceKeyMap.hs

Map Type

newtypenewtype KeyMap v

Source#

A map from JSON key type Key to v.

Instances38Functor, Foldable, Traversable, Arbitrary1, Align, Semialign, …

Functor KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Foldable KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Traversable KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Arbitrary1 KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Align KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Semialign KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Unzip KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Zip KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Filterable KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Witherable KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
FromJSON1 KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.Types.FromJSON
ToJSON1 KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
FoldableWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
FunctorWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
TraversableWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
SemialignWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
ZipWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
FilterableWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
WitherableWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Lift v => Lift (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
value ~ Value => KeyValue Value (KeyMap value)Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
Constructs a singleton KeyMap. For calling functions that demand an Object for constructing objects. To be used in conjunction with mconcat. Prefer to use object where possible.
value ~ Value => KeyValueOmit Value (KeyMap value)Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
IsList (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Eq v => Eq (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Data v => Data (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Ord v => Ord (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Read v => Read (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Show v => Show (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Semigroup (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Monoid (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
NFData v => NFData (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Arbitrary v => Arbitrary (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
CoArbitrary v => CoArbitrary (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Function v => Function (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
Hashable v => Hashable (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap
FromJSON v => FromJSON (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.Types.FromJSON
ToJSON v => ToJSON (KeyMap v)Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
type Item (KeyMap v) = (Key, v)Defined in aeson-2.2.5.1 · Data.Aeson.KeyMap

Query

valuenull :: KeyMap v -> Bool

Source#

Is the map empty?

valuelookup :: Key -> KeyMap v -> Maybe v

Source#

Return the value to which the specified key is mapped, or Nothing if this map contains no mapping for the key.

value(!?) :: KeyMap v -> Key -> Maybe v

Source#

Return the value to which the specified key is mapped, or Nothing if this map contains no mapping for the key.

This is a flipped version of lookup.

valuesize :: KeyMap v -> Int

Source#

Return the number of key-value mappings in this map.

valuemember :: Key -> KeyMap a -> Bool

Source#

Is the key a member of the map?

Construction

valueempty :: KeyMap v

Source#

Construct an empty map.

valuesingleton :: Key -> v -> KeyMap v

Source#

Construct a map with a single element.

Insertion

valueinsert :: Key -> v -> KeyMap v -> KeyMap v

Source#

Associate the specified value with the specified key in this map. If this map previously contained a mapping for the key, the old value is replaced.

valueinsertWith :: (a -> a -> a) -> Key -> a -> KeyMap a -> KeyMap a

Source#

Insert with a function combining new and old values, taken in that order.

Deletion

valuedelete :: Key -> KeyMap v -> KeyMap v

Source#

Remove the mapping for the specified key from this map if present.

Update

valuealterF

:: Functor f
=> Maybe v -> f (Maybe v)
-> Key
-> KeyMap v
-> f (KeyMap v)

Source#

alterF can be used to insert, delete, or update a value in a map.

Combine

valuedifference :: KeyMap v -> KeyMap v' -> KeyMap v

Source#

Difference of two maps. Return elements of the first map not existing in the second.

valueunion :: KeyMap v -> KeyMap v -> KeyMap v

Source#

The (left-biased) union of two maps. It prefers the first map when duplicate keys are encountered, i.e. (union == unionWith const).

valueunionWith :: (v -> v -> v) -> KeyMap v -> KeyMap v -> KeyMap v

Source#

The union with a combining function.

valueunionWithKey :: (Key -> v -> v -> v) -> KeyMap v -> KeyMap v -> KeyMap v

Source#

The union with a combining function.

valueintersection :: KeyMap a -> KeyMap b -> KeyMap a

Source#

The (left-biased) intersection of two maps (based on keys).

valueintersectionWith :: (a -> b -> c) -> KeyMap a -> KeyMap b -> KeyMap c

Source#

The intersection with a combining function.

valueintersectionWithKey

:: Key -> a -> b -> c
-> KeyMap a
-> KeyMap b
-> KeyMap c

Source#

The intersection with a combining function.

valuealignWith :: (These a b -> c) -> KeyMap a -> KeyMap b -> KeyMap c

Source#

Generalized union with combining function.

valuealignWithKey :: (Key -> These a b -> c) -> KeyMap a -> KeyMap b -> KeyMap c

Source#

Generalized union with combining function.

Lists

valuefromList :: [(Key, v)] -> KeyMap v

Source#

Construct a map with the supplied mappings. If the list contains duplicate mappings, the later mappings take precedence.

Example1 expression

>>> fromList [("a", 'x'), ("a", 'y')]fromList [("a",'y')]

valuefromListWith :: (v -> v -> v) -> [(Key, v)] -> KeyMap v

Source#

Construct a map from a list of elements. Uses the provided function, f, to merge duplicate entries with (f newVal oldVal).

valuetoList :: KeyMap v -> [(Key, v)]

Source#

Return a list of this map's keys and elements.

The order is not stable. Use toAscList for stable ordering.

valuetoAscList :: KeyMap v -> [(Key, v)]

Source#

Return a list of this map's elements in ascending order based of the textual key.

valueelems :: KeyMap v -> [v]

Source#

Return a list of this map' elements.

Maps

valuefromHashMap :: HashMap Key v -> KeyMap v

Source#

Convert a HashMap to a KeyMap.

valuetoHashMap :: KeyMap v -> HashMap Key v

Source#

Convert a KeyMap to a HashMap.

valuefromHashMapText :: HashMap Text v -> KeyMap v

Source#

Convert a HashMap Textto a KeyMap.

valuetoHashMapText :: KeyMap v -> HashMap Text v

Source#

Convert a KeyMap to a HashMap Text.

valuecoercionToHashMap :: Maybe (Coercion (HashMap Key v) (KeyMap v))

valuefromMap :: Map Key v -> KeyMap v

Source#

Convert a Map to a KeyMap.

valuetoMap :: KeyMap v -> Map Key v

Source#

Convert a KeyMap to a Map.

valuefromMapText :: Map Text v -> KeyMap v

Source#

Convert a Map Textto a KeyMap.

valuetoMapText :: KeyMap v -> Map Text v

Source#

Convert a KeyMap to a Map Text.

valuecoercionToMap :: Maybe (Coercion (Map Key v) (KeyMap v))

Traversal

Map

valuemap :: (a -> b) -> KeyMap a -> KeyMap b

Source#

Map a function over all values in the map.

valuemapWithKey :: (Key -> a -> b) -> KeyMap a -> KeyMap b

Source#

Map a function over all values in the map.

valuemapKeyVal :: (Key -> Key) -> (v1 -> v2) -> KeyMap v1 -> KeyMap v2

Source#

Transform the keys and values of a KeyMap.

valuetraverse :: Applicative f => (v1 -> f v2) -> KeyMap v1 -> f (KeyMap v2)

Source#

Perform an Applicative action for each key-value pair in a KeyMap and produce a KeyMap of all the results.

valuetraverseWithKey

:: Applicative f
=> Key -> v1 -> f v2
-> KeyMap v1
-> f (KeyMap v2)

Source#

Perform an Applicative action for each key-value pair in a KeyMap and produce a KeyMap of all the results.

Folds

valuefoldr :: (a -> b -> b) -> b -> KeyMap a -> b

valuefoldr' :: (a -> b -> b) -> b -> KeyMap a -> b

valuefoldl :: (b -> a -> b) -> b -> KeyMap a -> b

valuefoldl' :: (b -> a -> b) -> b -> KeyMap a -> b

valuefoldMapWithKey :: Monoid m => (Key -> a -> m) -> KeyMap a -> m

valuefoldrWithKey :: (Key -> v -> a -> a) -> a -> KeyMap v -> a

Source#

Reduce this map by applying a binary operator to all elements, using the given starting value (typically the right-identity of the operator).

Conversions

valuekeys :: KeyMap v -> [Key]

Source#

Return a list of this map's keys.

Filter

valuefilter :: (v -> Bool) -> KeyMap v -> KeyMap v

Source#

Filter all keys/values that satisfy some predicate.

valuefilterWithKey :: (Key -> v -> Bool) -> KeyMap v -> KeyMap v

Source#

Filter all keys/values that satisfy some predicate.

valuemapMaybe :: (a -> Maybe b) -> KeyMap a -> KeyMap b

Source#

Map values and collect the Just results.

valuemapMaybeWithKey :: (Key -> v -> Maybe u) -> KeyMap v -> KeyMap u

Source#

Map values and collect the Just results.

Key Type

newtypenewtype Key

Instances27Eq, Data, Ord, Read, Show, IsString, …

Eq KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
Data KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
Ord KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
Read KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
Show KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
IsString KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
Semigroup KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
Monoid KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
NFData KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
Arbitrary KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
CoArbitrary KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
Function KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
Hashable KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
FromJSON KeyDefined in aeson-2.2.5.1 · Data.Aeson.Types.FromJSON
FromJSONKey KeyDefined in aeson-2.2.5.1 · Data.Aeson.Types.FromJSON
ToJSON KeyDefined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
ToJSONKey KeyDefined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
Lift KeyDefined in aeson-2.2.5.1 · Data.Aeson.Key
FoldableWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
FunctorWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
TraversableWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
SemialignWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
ZipWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
FilterableWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
WitherableWithIndex Key KeyMapDefined in aeson-2.2.5.1 · Data.Aeson.KeyMap
FromPairs Value (DList Pair)Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
v ~ Value => KeyValuePair v (DList Pair)Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON