Copyright	(c) Sam Truzjan 2013
License	BSD3
Maintainer	[email protected]
Stability	stable
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.BEncode.Types

Contents

Types
Predicates

Description

Types for working with bencode data.

Synopsis

type BInteger = Integer
type BString = ByteString
type BList = [BValue]
type BDict = BDictMap BValue
data BValue
- = BInteger !BInteger
- | BString !BString
- | BList BList
- | BDict BDict
isInteger :: BValue -> Bool
isString :: BValue -> Bool
isList :: BValue -> Bool
isDict :: BValue -> Bool

Types

type BInteger = Integer Source #

A bencode "integer".

type BString = ByteString Source #

A raw bencode string.

type BList = [BValue] Source #

A plain bencode list.

type BDict = BDictMap BValue Source #

A bencode dictionary.

data BValue Source #

BValue is straightforward ADT for b-encoded values. Please note that since dictionaries are sorted, in most cases we can compare BEncoded values without serialization and vice versa. Lists is not required to be sorted through.

Constructors

BInteger !BInteger	bencode integers;
BString !BString	bencode strings;
BList BList	list of bencode values;
BDict BDict	bencode key-value dictionary.

Instances

Instances details

BEncode BDict Source #

Instance details

Defined in Data.BEncode

Methods

toBEncode :: BDict -> BValue Source #

fromBEncode :: BValue -> Result BDict Source #

BEncode BValue Source #

Instance details

Defined in Data.BEncode

Methods

toBEncode :: BValue -> BValue Source #

fromBEncode :: BValue -> Result BValue Source #

NFData BValue Source #

Instance details

Defined in Data.BEncode.Types

Methods

rnf :: BValue -> () #

Generic BValue Source #

Instance details

Defined in Data.BEncode.Types

Associated Types

type Rep BValue

Instance details

Defined in Data.BEncode.Types

type Rep BValue = D1 ('MetaData "BValue" "Data.BEncode.Types" "bencoding-0.4.5.6-J5FAiaSQ8J97FEmIzYPuBX" 'False) ((C1 ('MetaCons "BInteger" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BInteger)) :+: C1 ('MetaCons "BString" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BString))) :+: (C1 ('MetaCons "BList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BList)) :+: C1 ('MetaCons "BDict" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BDict))))

Methods

from :: BValue -> Rep BValue x #

to :: Rep BValue x -> BValue #

Read BValue Source #

Instance details

Defined in Data.BEncode.Types

Methods

readsPrec :: Int -> ReadS BValue #

readList :: ReadS [BValue] #

readPrec :: ReadPrec BValue #

readListPrec :: ReadPrec [BValue] #

Show BValue Source #

Instance details

Defined in Data.BEncode.Types

Methods

showsPrec :: Int -> BValue -> ShowS #

show :: BValue -> String #

showList :: [BValue] -> ShowS #

Eq BValue Source #

Instance details

Defined in Data.BEncode.Types

Methods

(==) :: BValue -> BValue -> Bool #

(/=) :: BValue -> BValue -> Bool #

Ord BValue Source #

Instance details

Defined in Data.BEncode.Types

Methods

compare :: BValue -> BValue -> Ordering #

(<) :: BValue -> BValue -> Bool #

(<=) :: BValue -> BValue -> Bool #

(>) :: BValue -> BValue -> Bool #

(>=) :: BValue -> BValue -> Bool #

max :: BValue -> BValue -> BValue #

min :: BValue -> BValue -> BValue #

type Rep BValue Source #

Instance details

Defined in Data.BEncode.Types

type Rep BValue = D1 ('MetaData "BValue" "Data.BEncode.Types" "bencoding-0.4.5.6-J5FAiaSQ8J97FEmIzYPuBX" 'False) ((C1 ('MetaCons "BInteger" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BInteger)) :+: C1 ('MetaCons "BString" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BString))) :+: (C1 ('MetaCons "BList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BList)) :+: C1 ('MetaCons "BDict" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BDict))))

Predicates

isInteger :: BValue -> Bool Source #

Test if bencoded value is an integer.

isString :: BValue -> Bool Source #

Test if bencoded value is a string, both raw and utf8 encoded.

isList :: BValue -> Bool Source #

Test if bencoded value is a list.

isDict :: BValue -> Bool Source #

Test if bencoded value is a dictionary.