Data.AttoBencode

BEncode Types

data BValue

The Haskell data type for Bencode values

Constructors

BString !ByteString

BInt !Integer

BList ![BValue]

BDict !Dict

Instances

Eq BValue

Show BValue

FromBencode BValue

ToBencode BValue

type Dict = Map ByteString BValue

A Bencode dictionary. Dictionaries have ByteString keys and BValue values.

Encoding and Decoding

decode :: FromBencode a => ByteString -> Maybe a

Deserialise a bencoded ByteString. If parsing or conversion fails, Nothing is returned.

encode :: ToBencode a => a -> ByteString

Serialise a Bencode value to a (strict) ByteString

class FromBencode a where

A type that can be converted from a BValue. The conversion can fail.

Methods

fromBencode :: BValue -> Maybe a

Instances

FromBencode Int

FromBencode Integer

FromBencode ByteString

FromBencode BValue

FromBencode a => FromBencode [a]

FromBencode a => FromBencode (Map ByteString a)

class ToBencode a where

A type that can be converted to a BValue.

Methods

toBencode :: a -> BValue

Instances

ToBencode Int

ToBencode Integer

ToBencode String

ToBencode ByteString

ToBencode BValue

ToBencode a => ToBencode [(ByteString, a)]

ToBencode a => ToBencode [a]

ToBencode a => ToBencode (Map ByteString a)

Convencience Functions

(.:) :: FromBencode a => Dict -> ByteString -> Maybe a

Look up the value corresponding to a (ByteString) key from a dictionary. Returns Nothing if the key is not in the dictionary or if the BValue cannot be converted to the expected type.

dict :: [(ByteString, BValue)] -> BValue

Make a BDict from a list of (key, value) tuples.

(.=) :: ToBencode a => ByteString -> a -> (ByteString, BValue)

Create a (key, value) tuple from a ByteString key and some bencode-able value. Can be used with the dict function as a convenient way to create BDicts.