Data.Persist

The Persist class

class Persist t where

Minimal complete definition

Nothing

Methods

put :: t -> Put ()

Encode a value in the Put monad.

get :: Get t

Decode a value in the Get monad

put :: (Generic t, GPersistPut (Rep t)) => t -> Put ()

Encode a value in the Put monad.

get :: (Generic t, GPersistGet (Rep t)) => Get t

Decode a value in the Get monad

Instances

Persist Bool

Defined in Data.Persist

Methods

put :: Bool -> Put ()

get :: Get Bool

Persist Char

Defined in Data.Persist

Methods

put :: Char -> Put ()

get :: Get Char

Persist Double

Defined in Data.Persist

Methods

put :: Double -> Put ()

get :: Get Double

Persist Float

Defined in Data.Persist

Methods

put :: Float -> Put ()

get :: Get Float

Persist Int

Defined in Data.Persist

Methods

put :: Int -> Put ()

get :: Get Int

Persist Int8

Defined in Data.Persist

Methods

put :: Int8 -> Put ()

get :: Get Int8

Persist Int16

Defined in Data.Persist

Methods

put :: Int16 -> Put ()

get :: Get Int16

Persist Int32

Defined in Data.Persist

Methods

put :: Int32 -> Put ()

get :: Get Int32

Persist Int64

Defined in Data.Persist

Methods

put :: Int64 -> Put ()

get :: Get Int64

Persist Integer

Defined in Data.Persist

Methods

put :: Integer -> Put ()

get :: Get Integer

Persist Natural

Defined in Data.Persist

Methods

put :: Natural -> Put ()

get :: Get Natural

Persist Ordering

Defined in Data.Persist

Methods

put :: Ordering -> Put ()

get :: Get Ordering

Persist Word

Defined in Data.Persist

Methods

put :: Word -> Put ()

get :: Get Word

Persist Word8

Defined in Data.Persist

Methods

put :: Word8 -> Put ()

get :: Get Word8

Persist Word16

Defined in Data.Persist

Methods

put :: Word16 -> Put ()

get :: Get Word16

Persist Word32

Defined in Data.Persist

Methods

put :: Word32 -> Put ()

get :: Get Word32

Persist Word64

Defined in Data.Persist

Methods

put :: Word64 -> Put ()

get :: Get Word64

Persist ()

Defined in Data.Persist

Methods

put :: () -> Put ()

get :: Get ()

Persist All

Defined in Data.Persist

Methods

put :: All -> Put ()

get :: Get All

Persist Any

Defined in Data.Persist

Methods

put :: Any -> Put ()

get :: Get Any

Persist ShortByteString

Defined in Data.Persist

Methods

put :: ShortByteString -> Put ()

get :: Get ShortByteString

Persist ByteString

Defined in Data.Persist

Methods

put :: ByteString -> Put ()

get :: Get ByteString

Persist ByteString

Defined in Data.Persist

Methods

put :: ByteString -> Put ()

get :: Get ByteString

Persist IntSet

Defined in Data.Persist

Methods

put :: IntSet -> Put ()

get :: Get IntSet

Persist Text

Defined in Data.Persist

Methods

put :: Text -> Put ()

get :: Get Text

Persist a => Persist [a]

Persist a list in the following format: Word64 (little endian format) element 1 ... element n

Defined in Data.Persist

Methods

put :: [a] -> Put ()

get :: Get [a]

Persist a => Persist (Maybe a)

Defined in Data.Persist

Methods

put :: Maybe a -> Put ()

get :: Get (Maybe a)

Persist a => Persist (Ratio a)

Defined in Data.Persist

Methods

put :: Ratio a -> Put ()

get :: Get (Ratio a)

Persist a => Persist (First a)

Defined in Data.Persist

Methods

put :: First a -> Put ()

get :: Get (First a)

Persist a => Persist (Last a)

Defined in Data.Persist

Methods

put :: Last a -> Put ()

get :: Get (Last a)

Persist a => Persist (Dual a)

Defined in Data.Persist

Methods

put :: Dual a -> Put ()

get :: Get (Dual a)

Persist a => Persist (Sum a)

Defined in Data.Persist

Methods

put :: Sum a -> Put ()

get :: Get (Sum a)

Persist a => Persist (Product a)

Defined in Data.Persist

Methods

put :: Product a -> Put ()

get :: Get (Product a)

Persist e => Persist (NonEmpty e)

Defined in Data.Persist

Methods

put :: NonEmpty e -> Put ()

get :: Get (NonEmpty e)

Persist e => Persist (IntMap e)

Defined in Data.Persist

Methods

put :: IntMap e -> Put ()

get :: Get (IntMap e)

Persist e => Persist (Tree e)

Defined in Data.Persist

Methods

put :: Tree e -> Put ()

get :: Get (Tree e)

Persist e => Persist (Seq e)

Defined in Data.Persist

Methods

put :: Seq e -> Put ()

get :: Get (Seq e)

(Ord a, Persist a) => Persist (Set a)

Defined in Data.Persist

Methods

put :: Set a -> Put ()

get :: Get (Set a)

Persist (LittleEndian Double)

Defined in Data.Persist

Methods

put :: LittleEndian Double -> Put ()

get :: Get (LittleEndian Double)

Persist (LittleEndian Float)

Defined in Data.Persist

Methods

put :: LittleEndian Float -> Put ()

get :: Get (LittleEndian Float)

Persist (LittleEndian Int)

Defined in Data.Persist

Methods

put :: LittleEndian Int -> Put ()

get :: Get (LittleEndian Int)

Persist (LittleEndian Int16)

Defined in Data.Persist

Methods

put :: LittleEndian Int16 -> Put ()

get :: Get (LittleEndian Int16)

Persist (LittleEndian Int32)

Defined in Data.Persist

Methods

put :: LittleEndian Int32 -> Put ()

get :: Get (LittleEndian Int32)

Persist (LittleEndian Int64)

Defined in Data.Persist

Methods

put :: LittleEndian Int64 -> Put ()

get :: Get (LittleEndian Int64)

Persist (LittleEndian Word)

Defined in Data.Persist

Methods

put :: LittleEndian Word -> Put ()

get :: Get (LittleEndian Word)

Persist (LittleEndian Word16)

Defined in Data.Persist

Methods

put :: LittleEndian Word16 -> Put ()

get :: Get (LittleEndian Word16)

Persist (LittleEndian Word32)

Defined in Data.Persist

Methods

put :: LittleEndian Word32 -> Put ()

get :: Get (LittleEndian Word32)

Persist (LittleEndian Word64)

Defined in Data.Persist

Methods

put :: LittleEndian Word64 -> Put ()

get :: Get (LittleEndian Word64)

Persist (BigEndian Double)

Defined in Data.Persist

Methods

put :: BigEndian Double -> Put ()

get :: Get (BigEndian Double)

Persist (BigEndian Float)

Defined in Data.Persist

Methods

put :: BigEndian Float -> Put ()

get :: Get (BigEndian Float)

Persist (BigEndian Int)

Defined in Data.Persist

Methods

put :: BigEndian Int -> Put ()

get :: Get (BigEndian Int)

Persist (BigEndian Int16)

Defined in Data.Persist

Methods

put :: BigEndian Int16 -> Put ()

get :: Get (BigEndian Int16)

Persist (BigEndian Int32)

Defined in Data.Persist

Methods

put :: BigEndian Int32 -> Put ()

get :: Get (BigEndian Int32)

Persist (BigEndian Int64)

Defined in Data.Persist

Methods

put :: BigEndian Int64 -> Put ()

get :: Get (BigEndian Int64)

Persist (BigEndian Word)

Defined in Data.Persist

Methods

put :: BigEndian Word -> Put ()

get :: Get (BigEndian Word)

Persist (BigEndian Word16)

Defined in Data.Persist

Methods

put :: BigEndian Word16 -> Put ()

get :: Get (BigEndian Word16)

Persist (BigEndian Word32)

Defined in Data.Persist

Methods

put :: BigEndian Word32 -> Put ()

get :: Get (BigEndian Word32)

Persist (BigEndian Word64)

Defined in Data.Persist

Methods

put :: BigEndian Word64 -> Put ()

get :: Get (BigEndian Word64)

(Persist a, Persist b) => Persist (Either a b)

Defined in Data.Persist

Methods

put :: Either a b -> Put ()

get :: Get (Either a b)

(Persist a, Persist b) => Persist (a, b)

Defined in Data.Persist

Methods

put :: (a, b) -> Put ()

get :: Get (a, b)

(Ord k, Persist k, Persist e) => Persist (Map k e)

Defined in Data.Persist

Methods

put :: Map k e -> Put ()

get :: Get (Map k e)

(Persist a, Persist b, Persist c) => Persist (a, b, c)

Defined in Data.Persist

Methods

put :: (a, b, c) -> Put ()

get :: Get (a, b, c)

(Persist a, Persist b, Persist c, Persist d) => Persist (a, b, c, d)

Defined in Data.Persist

Methods

put :: (a, b, c, d) -> Put ()

get :: Get (a, b, c, d)

(Persist a, Persist b, Persist c, Persist d, Persist e) => Persist (a, b, c, d, e)

Defined in Data.Persist

Methods

put :: (a, b, c, d, e) -> Put ()

get :: Get (a, b, c, d, e)

(Persist a, Persist b, Persist c, Persist d, Persist e, Persist f) => Persist (a, b, c, d, e, f)

Defined in Data.Persist

Methods

put :: (a, b, c, d, e, f) -> Put ()

get :: Get (a, b, c, d, e, f)

(Persist a, Persist b, Persist c, Persist d, Persist e, Persist f, Persist g) => Persist (a, b, c, d, e, f, g)

Defined in Data.Persist

Methods

put :: (a, b, c, d, e, f, g) -> Put ()

get :: Get (a, b, c, d, e, f, g)

Endianness

type HostEndian = LittleEndian

newtype BigEndian a

Constructors

BigEndian

Fields

• unBE :: a

Instances

Functor BigEndian

Defined in Data.Persist

Methods

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

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

Foldable BigEndian

Defined in Data.Persist

Methods

fold :: Monoid m => BigEndian m -> m

foldMap :: Monoid m => (a -> m) -> BigEndian a -> m

foldr :: (a -> b -> b) -> b -> BigEndian a -> b

foldr' :: (a -> b -> b) -> b -> BigEndian a -> b

foldl :: (b -> a -> b) -> b -> BigEndian a -> b

foldl' :: (b -> a -> b) -> b -> BigEndian a -> b

foldr1 :: (a -> a -> a) -> BigEndian a -> a

foldl1 :: (a -> a -> a) -> BigEndian a -> a

toList :: BigEndian a -> [a]

null :: BigEndian a -> Bool

length :: BigEndian a -> Int

elem :: Eq a => a -> BigEndian a -> Bool

maximum :: Ord a => BigEndian a -> a

minimum :: Ord a => BigEndian a -> a

sum :: Num a => BigEndian a -> a

product :: Num a => BigEndian a -> a

Traversable BigEndian

Defined in Data.Persist

Methods

traverse :: Applicative f => (a -> f b) -> BigEndian a -> f (BigEndian b)

sequenceA :: Applicative f => BigEndian (f a) -> f (BigEndian a)

mapM :: Monad m => (a -> m b) -> BigEndian a -> m (BigEndian b)

sequence :: Monad m => BigEndian (m a) -> m (BigEndian a)

Eq a => Eq (BigEndian a)

Defined in Data.Persist

Methods

(==) :: BigEndian a -> BigEndian a -> Bool

(/=) :: BigEndian a -> BigEndian a -> Bool

Ord a => Ord (BigEndian a)

Defined in Data.Persist

Methods

compare :: BigEndian a -> BigEndian a -> Ordering

(<) :: BigEndian a -> BigEndian a -> Bool

(<=) :: BigEndian a -> BigEndian a -> Bool

(>) :: BigEndian a -> BigEndian a -> Bool

(>=) :: BigEndian a -> BigEndian a -> Bool

max :: BigEndian a -> BigEndian a -> BigEndian a

min :: BigEndian a -> BigEndian a -> BigEndian a

Show a => Show (BigEndian a)

Defined in Data.Persist

Methods

showsPrec :: Int -> BigEndian a -> ShowS

show :: BigEndian a -> String

showList :: [BigEndian a] -> ShowS

Generic (BigEndian a)

Defined in Data.Persist

Associated Types

type Rep (BigEndian a) :: Type -> Type

Methods

from :: BigEndian a -> Rep (BigEndian a) x

to :: Rep (BigEndian a) x -> BigEndian a

Persist (BigEndian Double)

Defined in Data.Persist

Methods

put :: BigEndian Double -> Put ()

get :: Get (BigEndian Double)

Persist (BigEndian Float)

Defined in Data.Persist

Methods

put :: BigEndian Float -> Put ()

get :: Get (BigEndian Float)

Persist (BigEndian Int)

Defined in Data.Persist

Methods

put :: BigEndian Int -> Put ()

get :: Get (BigEndian Int)

Persist (BigEndian Int16)

Defined in Data.Persist

Methods

put :: BigEndian Int16 -> Put ()

get :: Get (BigEndian Int16)

Persist (BigEndian Int32)

Defined in Data.Persist

Methods

put :: BigEndian Int32 -> Put ()

get :: Get (BigEndian Int32)

Persist (BigEndian Int64)

Defined in Data.Persist

Methods

put :: BigEndian Int64 -> Put ()

get :: Get (BigEndian Int64)

Persist (BigEndian Word)

Defined in Data.Persist

Methods

put :: BigEndian Word -> Put ()

get :: Get (BigEndian Word)

Persist (BigEndian Word16)

Defined in Data.Persist

Methods

put :: BigEndian Word16 -> Put ()

get :: Get (BigEndian Word16)

Persist (BigEndian Word32)

Defined in Data.Persist

Methods

put :: BigEndian Word32 -> Put ()

get :: Get (BigEndian Word32)

Persist (BigEndian Word64)

Defined in Data.Persist

Methods

put :: BigEndian Word64 -> Put ()

get :: Get (BigEndian Word64)

type Rep (BigEndian a)

Defined in Data.Persist

type Rep (BigEndian a) = D1 (MetaData "BigEndian" "Data.Persist" "persist-0.1.1.2-2pkQX7txtjIHJLm2eY4oS3" True) (C1 (MetaCons "BigEndian" PrefixI True) (S1 (MetaSel (Just "unBE") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))

newtype LittleEndian a

Constructors

LittleEndian

Fields

• unLE :: a

Instances

Functor LittleEndian

Defined in Data.Persist

Methods

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

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

Foldable LittleEndian

Defined in Data.Persist

Methods

fold :: Monoid m => LittleEndian m -> m

foldMap :: Monoid m => (a -> m) -> LittleEndian a -> m

foldr :: (a -> b -> b) -> b -> LittleEndian a -> b

foldr' :: (a -> b -> b) -> b -> LittleEndian a -> b

foldl :: (b -> a -> b) -> b -> LittleEndian a -> b

foldl' :: (b -> a -> b) -> b -> LittleEndian a -> b

foldr1 :: (a -> a -> a) -> LittleEndian a -> a

foldl1 :: (a -> a -> a) -> LittleEndian a -> a

toList :: LittleEndian a -> [a]

null :: LittleEndian a -> Bool

length :: LittleEndian a -> Int

elem :: Eq a => a -> LittleEndian a -> Bool

maximum :: Ord a => LittleEndian a -> a

minimum :: Ord a => LittleEndian a -> a

sum :: Num a => LittleEndian a -> a

product :: Num a => LittleEndian a -> a

Traversable LittleEndian

Defined in Data.Persist

Methods

traverse :: Applicative f => (a -> f b) -> LittleEndian a -> f (LittleEndian b)

sequenceA :: Applicative f => LittleEndian (f a) -> f (LittleEndian a)

mapM :: Monad m => (a -> m b) -> LittleEndian a -> m (LittleEndian b)

sequence :: Monad m => LittleEndian (m a) -> m (LittleEndian a)

Eq a => Eq (LittleEndian a)

Defined in Data.Persist

Methods

(==) :: LittleEndian a -> LittleEndian a -> Bool

(/=) :: LittleEndian a -> LittleEndian a -> Bool

Ord a => Ord (LittleEndian a)

Defined in Data.Persist

Methods

compare :: LittleEndian a -> LittleEndian a -> Ordering

(<) :: LittleEndian a -> LittleEndian a -> Bool

(<=) :: LittleEndian a -> LittleEndian a -> Bool

(>) :: LittleEndian a -> LittleEndian a -> Bool

(>=) :: LittleEndian a -> LittleEndian a -> Bool

max :: LittleEndian a -> LittleEndian a -> LittleEndian a

min :: LittleEndian a -> LittleEndian a -> LittleEndian a

Show a => Show (LittleEndian a)

Defined in Data.Persist

Methods

showsPrec :: Int -> LittleEndian a -> ShowS

show :: LittleEndian a -> String

showList :: [LittleEndian a] -> ShowS

Generic (LittleEndian a)

Defined in Data.Persist

Associated Types

type Rep (LittleEndian a) :: Type -> Type

Methods

from :: LittleEndian a -> Rep (LittleEndian a) x

to :: Rep (LittleEndian a) x -> LittleEndian a

Persist (LittleEndian Double)

Defined in Data.Persist

Methods

put :: LittleEndian Double -> Put ()

get :: Get (LittleEndian Double)

Persist (LittleEndian Float)

Defined in Data.Persist

Methods

put :: LittleEndian Float -> Put ()

get :: Get (LittleEndian Float)

Persist (LittleEndian Int)

Defined in Data.Persist

Methods

put :: LittleEndian Int -> Put ()

get :: Get (LittleEndian Int)

Persist (LittleEndian Int16)

Defined in Data.Persist

Methods

put :: LittleEndian Int16 -> Put ()

get :: Get (LittleEndian Int16)

Persist (LittleEndian Int32)

Defined in Data.Persist

Methods

put :: LittleEndian Int32 -> Put ()

get :: Get (LittleEndian Int32)

Persist (LittleEndian Int64)

Defined in Data.Persist

Methods

put :: LittleEndian Int64 -> Put ()

get :: Get (LittleEndian Int64)

Persist (LittleEndian Word)

Defined in Data.Persist

Methods

put :: LittleEndian Word -> Put ()

get :: Get (LittleEndian Word)

Persist (LittleEndian Word16)

Defined in Data.Persist

Methods

put :: LittleEndian Word16 -> Put ()

get :: Get (LittleEndian Word16)

Persist (LittleEndian Word32)

Defined in Data.Persist

Methods

put :: LittleEndian Word32 -> Put ()

get :: Get (LittleEndian Word32)

Persist (LittleEndian Word64)

Defined in Data.Persist

Methods

put :: LittleEndian Word64 -> Put ()

get :: Get (LittleEndian Word64)

type Rep (LittleEndian a)

Defined in Data.Persist

type Rep (LittleEndian a) = D1 (MetaData "LittleEndian" "Data.Persist" "persist-0.1.1.2-2pkQX7txtjIHJLm2eY4oS3" True) (C1 (MetaCons "LittleEndian" PrefixI True) (S1 (MetaSel (Just "unLE") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))

Serialization

encode :: Persist a => a -> ByteString

Encode a value using binary serialization to a strict ByteString.

decode :: Persist a => ByteString -> Either String a

Decode a value from a strict ByteString, reconstructing the original structure.

The Get type

data Get a

Instances

Monad Get

Defined in Data.Persist

Methods

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

(>>) :: Get a -> Get b -> Get b

return :: a -> Get a

fail :: String -> Get a

Functor Get

Defined in Data.Persist

Methods

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

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

MonadFail Get

Defined in Data.Persist

Methods

fail :: String -> Get a

Applicative Get

Defined in Data.Persist

Methods

pure :: a -> Get a

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

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

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

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

runGet :: Get a -> ByteString -> Either String a

Run the Get monad applies a get-based parser on the input ByteString

ensure :: Int -> Get ()

Ensure that n bytes are available. Fails if fewer than n bytes are available.

skip :: Int -> Get ()

Skip ahead n bytes. Fails if fewer than n bytes are available.

getBytes :: Int -> Get ByteString

Pull n bytes from the input, as a strict ByteString.

getByteString :: Int -> Get ByteString

An efficient get method for strict ByteStrings. Fails if fewer than n bytes are left in the input. This function creates a fresh copy of the underlying bytes.

remaining :: Get Int

Get the number of remaining unparsed bytes. Useful for checking whether all input has been consumed.

eof :: Get ()

getHE :: Persist (HostEndian a) => Get a

getLE :: Persist (LittleEndian a) => Get a

getBE :: Persist (BigEndian a) => Get a

The Put type

data Put a

Instances

Monad Put

Defined in Data.Persist

Methods

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

(>>) :: Put a -> Put b -> Put b

return :: a -> Put a

fail :: String -> Put a

Functor Put

Defined in Data.Persist

Methods

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

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

Applicative Put

Defined in Data.Persist

Methods

pure :: a -> Put a

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

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

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

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

runPut :: Put a -> ByteString

evalPut :: Put a -> (a, ByteString)

grow :: Int -> Put ()

Ensure that n bytes can be written.

putByteString :: ByteString -> Put ()

putHE :: Persist (HostEndian a) => a -> Put ()

putLE :: Persist (LittleEndian a) => a -> Put ()

putBE :: Persist (BigEndian a) => a -> Put ()