Data.BEncode.BDict

This module defines a simple key/value list ordered by keys which both faster and more suitable for bencode dictionaries than just [(k,v)].

Documentation

type BKey = BS.ByteString

data BDictMap a

BDictMap is an ascending list of key/value pairs sorted by keys.

Constructors

Cons !BKey a !(BDictMap a)

Nil

Instances

Functor BDictMap

Foldable BDictMap

BEncode BDict

Eq a => Eq (BDictMap a)

Ord a => Ord (BDictMap a)

Read a => Read (BDictMap a)

Show a => Show (BDictMap a)

Monoid (BDictMap a)

NFData a => NFData (BDictMap a)

Construction

empty :: BDictMap a

O(1). The empty dicionary.

singleton :: BKey -> a -> BDictMap a

O(1). Dictionary of one key-value pair.

Query

null :: BDictMap a -> Bool

O(1). Is the dictionary empty?

member :: BKey -> BDictMap a -> Bool

O(n). Is the key a member of the dictionary?

lookup :: BKey -> BDictMap a -> Maybe a

O(n). Lookup the value at a key in the dictionary.

Combine

union :: BDictMap a -> BDictMap a -> BDictMap a

O(n + m). Merge two dictionaries by taking pair from both given dictionaries. Dublicated keys are not filtered.

Traversal

map :: (a -> b) -> BDictMap a -> BDictMap b

O(n). Map a function over all values in the dictionary.

bifoldMap :: Monoid m => (BKey -> a -> m) -> BDictMap a -> m

O(n). Map each key/value pair to a monoid and fold resulting sequnce using mappend.

Conversion

fromAscList :: [(BKey, a)] -> BDictMap a

O(n). Build a dictionary from a list of key/value pairs where the keys are in ascending order.

toAscList :: BDictMap a -> [(BKey, a)]

O(n). Convert the dictionary to a list of key/value pairs where the keys are in ascending order.