Copyright	(c) Sam Truzjan 2013
License	BSD3
Maintainer	pxqr.sta@gmail.com
Stability	stable
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.BEncode.BDict

Contents

Construction
Query
Combine
Maps
Folds
Conversion

Description

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

Synopsis

type BKey = ByteString
data BDictMap a
- = Cons !BKey a !(BDictMap a)
- | Nil
empty :: BDictMap a
singleton :: BKey -> a -> BDictMap a
null :: BDictMap a -> Bool
member :: BKey -> BDictMap a -> Bool
lookup :: BKey -> BDictMap a -> Maybe a
union :: BDictMap a -> BDictMap a -> BDictMap a
map :: (a -> b) -> BDictMap a -> BDictMap b
mapWithKey :: (BKey -> a -> b) -> BDictMap a -> BDictMap b
foldMapWithKey :: Monoid m => (BKey -> a -> m) -> BDictMap a -> m
bifoldMap :: Monoid m => (BKey -> a -> m) -> BDictMap a -> m
fromAscList :: [(BKey, a)] -> BDictMap a
toAscList :: BDictMap a -> [(BKey, a)]

Documentation

type BKey = ByteString Source #

data BDictMap a Source #

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

Constructors

Cons !BKey a !(BDictMap a)
Nil

Instances

Instances details

Foldable BDictMap Source #
Instance details Defined in Data.BEncode.BDict Methods fold :: Monoid m => BDictMap m -> m # foldMap :: Monoid m => (a -> m) -> BDictMap a -> m # foldMap' :: Monoid m => (a -> m) -> BDictMap a -> m # foldr :: (a -> b -> b) -> b -> BDictMap a -> b # foldr' :: (a -> b -> b) -> b -> BDictMap a -> b # foldl :: (b -> a -> b) -> b -> BDictMap a -> b # foldl' :: (b -> a -> b) -> b -> BDictMap a -> b # foldr1 :: (a -> a -> a) -> BDictMap a -> a # foldl1 :: (a -> a -> a) -> BDictMap a -> a # toList :: BDictMap a -> [a] # null :: BDictMap a -> Bool # length :: BDictMap a -> Int # elem :: Eq a => a -> BDictMap a -> Bool # maximum :: Ord a => BDictMap a -> a # minimum :: Ord a => BDictMap a -> a # sum :: Num a => BDictMap a -> a # product :: Num a => BDictMap a -> a #
Functor BDictMap Source #
Instance details Defined in Data.BEncode.BDict Methods fmap :: (a -> b) -> BDictMap a -> BDictMap b # (<$) :: a -> BDictMap b -> BDictMap a #
BEncode BDict Source #
Instance details Defined in Data.BEncode Methods toBEncode :: BDict -> BValue Source # fromBEncode :: BValue -> Result BDict Source #
Monoid (BDictMap a) Source #
Instance details Defined in Data.BEncode.BDict Methods mempty :: BDictMap a # mappend :: BDictMap a -> BDictMap a -> BDictMap a # mconcat :: [BDictMap a] -> BDictMap a #
Semigroup (BDictMap a) Source #
Instance details Defined in Data.BEncode.BDict Methods (<>) :: BDictMap a -> BDictMap a -> BDictMap a # sconcat :: NonEmpty (BDictMap a) -> BDictMap a # stimes :: Integral b => b -> BDictMap a -> BDictMap a #
Generic (BDictMap a) Source #
Instance details Defined in Data.BEncode.BDict Associated Types type Rep (BDictMap a) :: Type -> Type # Methods from :: BDictMap a -> Rep (BDictMap a) x # to :: Rep (BDictMap a) x -> BDictMap a #
Read a => Read (BDictMap a) Source #
Instance details Defined in Data.BEncode.BDict Methods readsPrec :: Int -> ReadS (BDictMap a) # readList :: ReadS [BDictMap a] # readPrec :: ReadPrec (BDictMap a) # readListPrec :: ReadPrec [BDictMap a] #
Show a => Show (BDictMap a) Source #
Instance details Defined in Data.BEncode.BDict Methods showsPrec :: Int -> BDictMap a -> ShowS # show :: BDictMap a -> String # showList :: [BDictMap a] -> ShowS #
NFData a => NFData (BDictMap a) Source #
Instance details Defined in Data.BEncode.BDict Methods rnf :: BDictMap a -> () #
Eq a => Eq (BDictMap a) Source #
Instance details Defined in Data.BEncode.BDict Methods (==) :: BDictMap a -> BDictMap a -> Bool # (/=) :: BDictMap a -> BDictMap a -> Bool #
Ord a => Ord (BDictMap a) Source #
Instance details Defined in Data.BEncode.BDict Methods compare :: BDictMap a -> BDictMap a -> Ordering # (<) :: BDictMap a -> BDictMap a -> Bool # (<=) :: BDictMap a -> BDictMap a -> Bool # (>) :: BDictMap a -> BDictMap a -> Bool # (>=) :: BDictMap a -> BDictMap a -> Bool # max :: BDictMap a -> BDictMap a -> BDictMap a # min :: BDictMap a -> BDictMap a -> BDictMap a #
type Rep (BDictMap a) Source #
Instance details Defined in Data.BEncode.BDict type Rep (BDictMap a) = D1 ('MetaData "BDictMap" "Data.BEncode.BDict" "bencoding-0.4.5.5-LEWPPNw2oELCynG8CYG71M" 'False) (C1 ('MetaCons "Cons" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BKey) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (BDictMap a)))) :+: C1 ('MetaCons "Nil" 'PrefixI 'False) (U1 :: Type -> Type))

Construction

empty :: BDictMap a Source #

O(1). The empty dicionary.

singleton :: BKey -> a -> BDictMap a Source #

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

Query

null :: BDictMap a -> Bool Source #

O(1). Is the dictionary empty?

member :: BKey -> BDictMap a -> Bool Source #

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

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

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

Combine

union :: BDictMap a -> BDictMap a -> BDictMap a Source #

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

Maps

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

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

mapWithKey :: (BKey -> a -> b) -> BDictMap a -> BDictMap b Source #

O(n). Map a function over all keys/value pairs in the dictionary.

Folds

foldMapWithKey :: Monoid m => (BKey -> a -> m) -> BDictMap a -> m Source #

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

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

Deprecated: Use foldMapWithKey instead

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

Conversion

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

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

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

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