Data.PackStream.Internal.Type

PackStream basics

data PackStreamError

Basic PackStream error type that is used to handle parsing errors.

Constructors

NotNull

This ByteString doesn't represent null object

NotBool

This ByteString doesn't represent any boolean

NotWord

This ByteString doesn't represent any unsigned integer

NotInt

This ByteString doesn't represent any integer

NotFloat

This ByteString doesn't represent any floating-point number

NotString

This ByteString doesn't represent any Text string

NotBytes

This ByteString doesn't represent any ByteString array

NotList

This ByteString doesn't represent any list of PackStream values

NotDict

This ByteString doesn't represent any dictionary of PackStream values

NotStructure

This ByteString doesn't represent any Structure

NotValue

This ByteString doesn't represent any Value

WrongStructure Text

This ByteString doesn't represent specific Structure

Instances

Eq PackStreamError

Defined in Data.PackStream.Internal.Type

Methods

(==) :: PackStreamError -> PackStreamError -> Bool

(/=) :: PackStreamError -> PackStreamError -> Bool

Ord PackStreamError

Defined in Data.PackStream.Internal.Type

Methods

compare :: PackStreamError -> PackStreamError -> Ordering

(<) :: PackStreamError -> PackStreamError -> Bool

(<=) :: PackStreamError -> PackStreamError -> Bool

(>) :: PackStreamError -> PackStreamError -> Bool

(>=) :: PackStreamError -> PackStreamError -> Bool

max :: PackStreamError -> PackStreamError -> PackStreamError

min :: PackStreamError -> PackStreamError -> PackStreamError

Show PackStreamError

Defined in Data.PackStream.Internal.Type

Methods

showsPrec :: Int -> PackStreamError -> ShowS

show :: PackStreamError -> String

showList :: [PackStreamError] -> ShowS

MonadError PackStreamError PackStream

Defined in Data.PackStream.Internal.Type

Methods

throwError :: PackStreamError -> PackStream a

catchError :: PackStream a -> (PackStreamError -> PackStream a) -> PackStream a

newtype PackStream a

Basic parser type. It works like parser combinators for binary data that represents PackStream.

Constructors

PackStream

Fields

• runUnpackS :: ExceptT PackStreamError (State ByteString) a

Instances

Monad PackStream

Defined in Data.PackStream.Internal.Type

Methods

(>>=) :: PackStream a -> (a -> PackStream b) -> PackStream b

(>>) :: PackStream a -> PackStream b -> PackStream b

return :: a -> PackStream a

Functor PackStream

Defined in Data.PackStream.Internal.Type

Methods

fmap :: (a -> b) -> PackStream a -> PackStream b

(<$) :: a -> PackStream b -> PackStream a

Applicative PackStream

Defined in Data.PackStream.Internal.Type

Methods

pure :: a -> PackStream a

(<*>) :: PackStream (a -> b) -> PackStream a -> PackStream b

liftA2 :: (a -> b -> c) -> PackStream a -> PackStream b -> PackStream c

(*>) :: PackStream a -> PackStream b -> PackStream b

(<*) :: PackStream a -> PackStream b -> PackStream a

MonadState ByteString PackStream

Defined in Data.PackStream.Internal.Type

Methods

get :: PackStream ByteString

put :: ByteString -> PackStream ()

state :: (ByteString -> (a, ByteString)) -> PackStream a

MonadError PackStreamError PackStream

Defined in Data.PackStream.Internal.Type

Methods

throwError :: PackStreamError -> PackStream a

catchError :: PackStream a -> (PackStreamError -> PackStream a) -> PackStream a

unpackStream :: PackStream a -> ByteString -> Either PackStreamError a

Use specific parser combinator to parse the ByteString that represents any PackStream data.

data Value

PackStream offers a number of core data types, many supported by multiple binary representations, as well as a flexible extension mechanism.

Constructors

N

Missing or empty value

B Bool

True or False

I Int

Signed 64-bit integer

F Double

64-bit floating point number

U ByteString

Byte array

T Text

Unicode text, UTF-8

L [Value]

Ordered collection of Values

D (Map Text Value)

Collection of key-value entries (no order guaranteed)

S Structure

Composite value with a type signature

Instances

Eq Value

Defined in Data.PackStream.Internal.Type

Methods

(==) :: Value -> Value -> Bool

(/=) :: Value -> Value -> Bool

Show Value

Defined in Data.PackStream.Internal.Type

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

FromValue Value

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError Value

ToValue Value

Defined in Data.PackStream.Internal.Type

Methods

toValue :: Value -> Value

PackStreamValue Value

Defined in Data.PackStream

Methods

pack :: Value -> ByteString

unpack :: PackStream Value

data Structure

A structure is a composite value, comprised of fields and a unique type code. Structure encodings consist, beyond the marker, of a single byte, the tag byte, followed by a sequence of up to 15 fields, each an individual value. The size of a structure is measured as the number of fields and not the total byte size. This count does not include the tag.

Constructors

Structure

Fields

• signature :: Word8

  Type code

• fields :: [Value]

  Structure fields

Instances

Eq Structure

Defined in Data.PackStream.Internal.Type

Methods

(==) :: Structure -> Structure -> Bool

(/=) :: Structure -> Structure -> Bool

Show Structure

Defined in Data.PackStream.Internal.Type

Methods

showsPrec :: Int -> Structure -> ShowS

show :: Structure -> String

showList :: [Structure] -> ShowS

FromValue Structure

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError Structure

ToValue Structure

Defined in Data.PackStream.Internal.Type

Methods

toValue :: Structure -> Value

PackStreamValue Structure

Defined in Data.PackStream

Methods

pack :: Structure -> ByteString

unpack :: PackStream Structure

class ToValue a where

The data types that can be serialized as PackStream

Methods

toValue :: a -> Value

Convert data type to the generic Value

Instances

ToValue Bool

Defined in Data.PackStream.Internal.Type

Methods

toValue :: Bool -> Value

ToValue Double

Defined in Data.PackStream.Internal.Type

Methods

toValue :: Double -> Value

ToValue Int

Defined in Data.PackStream.Internal.Type

Methods

toValue :: Int -> Value

ToValue Integer

Defined in Data.PackStream.Internal.Type

Methods

toValue :: Integer -> Value

ToValue ()

Defined in Data.PackStream.Internal.Type

Methods

toValue :: () -> Value

ToValue ByteString

Defined in Data.PackStream.Internal.Type

Methods

toValue :: ByteString -> Value

ToValue Text

Defined in Data.PackStream.Internal.Type

Methods

toValue :: Text -> Value

ToValue Structure

Defined in Data.PackStream.Internal.Type

Methods

toValue :: Structure -> Value

ToValue Value

Defined in Data.PackStream.Internal.Type

Methods

toValue :: Value -> Value

ToValue a => ToValue [a]

Defined in Data.PackStream.Internal.Type

Methods

toValue :: [a] -> Value

ToValue a => ToValue (Map Text a)

Defined in Data.PackStream.Internal.Type

Methods

toValue :: Map Text a -> Value

(=:) :: ToValue a => Text -> a -> (Text, Value)

Represent a Text key and some ToValue data into the Map pair. Can be useful to work with PackStream dictionaries.

fromList ["hello" =: 1, "world" =: False]

class FromValue a where

The data types taht can be read from PackStream representation

Methods

fromValue :: Value -> Either PackStreamError a

Converts generic Value type to a specific one or raises PackStreamError

Instances

FromValue Bool

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError Bool

FromValue Double

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError Double

FromValue Int

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError Int

FromValue Integer

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError Integer

FromValue ()

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError ()

FromValue ByteString

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError ByteString

FromValue Text

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError Text

FromValue Structure

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError Structure

FromValue Value

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError Value

FromValue a => FromValue [a]

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError [a]

FromValue a => FromValue (Map Text a)

Defined in Data.PackStream.Internal.Type

Methods

fromValue :: Value -> Either PackStreamError (Map Text a)