Safe Haskell	Safe-Inferred
Language	Haskell2010

ZkFold.Base.Data.ByteString

Synopsis

class Binary t where
- put :: t -> Put
- get :: Get t
- putList :: [t] -> Put
toByteString :: Binary a => a -> ByteString
fromByteString :: Binary a => ByteString -> Maybe a
putWord8 :: Word8 -> Put
getWord8 :: Get Word8
newtype LittleEndian = LittleEndian {
- unLittleEndian :: Natural
}

Documentation

class Binary t where #

The Binary class provides put and get, methods to encode and decode a Haskell value to a lazy ByteString. It mirrors the Read and Show classes for textual representation of Haskell types, and is suitable for serialising Haskell values to disk, over the network.

For decoding and generating simple external binary formats (e.g. C structures), Binary may be used, but in general is not suitable for complex protocols. Instead use the PutM and Get primitives directly.

Instances of Binary should satisfy the following property:

decode . encode == id

That is, the get and put methods should be the inverse of each other. A range of instances are provided for basic Haskell types.

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

putList :: [t] -> Put #

Encode a list of values in the Put monad. The default implementation may be overridden to be more efficient but must still have the same encoding format.

Instances

Instances details

Binary All	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: All -> Put # get :: Get All # putList :: [All] -> Put #
Binary Any	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Any -> Put # get :: Get Any # putList :: [Any] -> Put #
Binary SomeTypeRep
Instance details Defined in Data.Binary.Class Methods put :: SomeTypeRep -> Put # get :: Get SomeTypeRep # putList :: [SomeTypeRep] -> Put #
Binary Version	Since: binary-0.8.0.0
Instance details Defined in Data.Binary.Class Methods put :: Version -> Put # get :: Get Version # putList :: [Version] -> Put #
Binary Void	Since: binary-0.8.0.0
Instance details Defined in Data.Binary.Class Methods put :: Void -> Put # get :: Get Void # putList :: [Void] -> Put #
Binary Fingerprint	Since: binary-0.7.6.0
Instance details Defined in Data.Binary.Class Methods put :: Fingerprint -> Put # get :: Get Fingerprint # putList :: [Fingerprint] -> Put #
Binary Int16
Instance details Defined in Data.Binary.Class Methods put :: Int16 -> Put # get :: Get Int16 # putList :: [Int16] -> Put #
Binary Int32
Instance details Defined in Data.Binary.Class Methods put :: Int32 -> Put # get :: Get Int32 # putList :: [Int32] -> Put #
Binary Int64
Instance details Defined in Data.Binary.Class Methods put :: Int64 -> Put # get :: Get Int64 # putList :: [Int64] -> Put #
Binary Int8
Instance details Defined in Data.Binary.Class Methods put :: Int8 -> Put # get :: Get Int8 # putList :: [Int8] -> Put #
Binary Word16
Instance details Defined in Data.Binary.Class Methods put :: Word16 -> Put # get :: Get Word16 # putList :: [Word16] -> Put #
Binary Word32
Instance details Defined in Data.Binary.Class Methods put :: Word32 -> Put # get :: Get Word32 # putList :: [Word32] -> Put #
Binary Word64
Instance details Defined in Data.Binary.Class Methods put :: Word64 -> Put # get :: Get Word64 # putList :: [Word64] -> Put #
Binary Word8
Instance details Defined in Data.Binary.Class Methods put :: Word8 -> Put # get :: Get Word8 # putList :: [Word8] -> Put #
Binary ByteString
Instance details Defined in Data.Binary.Class Methods put :: ByteString -> Put # get :: Get ByteString # putList :: [ByteString] -> Put #
Binary ByteString
Instance details Defined in Data.Binary.Class Methods put :: ByteString -> Put # get :: Get ByteString # putList :: [ByteString] -> Put #
Binary ShortByteString
Instance details Defined in Data.Binary.Class Methods put :: ShortByteString -> Put # get :: Get ShortByteString # putList :: [ShortByteString] -> Put #
Binary IntSet
Instance details Defined in Data.Binary.Class Methods put :: IntSet -> Put # get :: Get IntSet # putList :: [IntSet] -> Put #
Binary KindRep	Since: binary-0.8.5.0
Instance details Defined in Data.Binary.Class Methods put :: KindRep -> Put # get :: Get KindRep # putList :: [KindRep] -> Put #
Binary Ordering
Instance details Defined in Data.Binary.Class Methods put :: Ordering -> Put # get :: Get Ordering # putList :: [Ordering] -> Put #
Binary TyCon	Since: binary-0.8.5.0
Instance details Defined in Data.Binary.Class Methods put :: TyCon -> Put # get :: Get TyCon # putList :: [TyCon] -> Put #
Binary TypeLitSort	Since: binary-0.8.5.0
Instance details Defined in Data.Binary.Class Methods put :: TypeLitSort -> Put # get :: Get TypeLitSort # putList :: [TypeLitSort] -> Put #
Binary Scientific	Note that in the future I intend to change the type of the `base10Exponent` from `Int` to `Integer`. To be forward compatible the `Binary` instance already encodes the exponent as `Integer`.
Instance details Defined in Data.Scientific Methods put :: Scientific -> Put # get :: Get Scientific # putList :: [Scientific] -> Put #
Binary ShortText	The `Binary` encoding matches the one for `Text`
Instance details Defined in Data.Text.Short.Internal Methods put :: ShortText -> Put # get :: Get ShortText # putList :: [ShortText] -> Put #
Binary UUID	This `Binary` instance is compatible with RFC 4122, storing the fields in network order as 16 bytes.
Instance details Defined in Data.UUID.Types.Internal Methods put :: UUID -> Put # get :: Get UUID # putList :: [UUID] -> Put #
Binary LittleEndian Source #
Instance details Defined in ZkFold.Base.Data.ByteString Methods put :: LittleEndian -> Put # get :: Get LittleEndian # putList :: [LittleEndian] -> Put #
Binary Integer
Instance details Defined in Data.Binary.Class Methods put :: Integer -> Put # get :: Get Integer # putList :: [Integer] -> Put #
Binary Natural	Since: binary-0.7.3.0
Instance details Defined in Data.Binary.Class Methods put :: Natural -> Put # get :: Get Natural # putList :: [Natural] -> Put #
Binary ()
Instance details Defined in Data.Binary.Class Methods put :: () -> Put # get :: Get () # putList :: [()] -> Put #
Binary Bool
Instance details Defined in Data.Binary.Class Methods put :: Bool -> Put # get :: Get Bool # putList :: [Bool] -> Put #
Binary Char
Instance details Defined in Data.Binary.Class Methods put :: Char -> Put # get :: Get Char # putList :: [Char] -> Put #
Binary Double
Instance details Defined in Data.Binary.Class Methods put :: Double -> Put # get :: Get Double # putList :: [Double] -> Put #
Binary Float
Instance details Defined in Data.Binary.Class Methods put :: Float -> Put # get :: Get Float # putList :: [Float] -> Put #
Binary Int
Instance details Defined in Data.Binary.Class Methods put :: Int -> Put # get :: Get Int # putList :: [Int] -> Put #
Binary RuntimeRep	Since: binary-0.8.5.0
Instance details Defined in Data.Binary.Class Methods put :: RuntimeRep -> Put # get :: Get RuntimeRep # putList :: [RuntimeRep] -> Put #
Binary VecCount	Since: binary-0.8.5.0
Instance details Defined in Data.Binary.Class Methods put :: VecCount -> Put # get :: Get VecCount # putList :: [VecCount] -> Put #
Binary VecElem	Since: binary-0.8.5.0
Instance details Defined in Data.Binary.Class Methods put :: VecElem -> Put # get :: Get VecElem # putList :: [VecElem] -> Put #
Binary Word
Instance details Defined in Data.Binary.Class Methods put :: Word -> Put # get :: Get Word # putList :: [Word] -> Put #
Binary a => Binary (Complex a)
Instance details Defined in Data.Binary.Class Methods put :: Complex a -> Put # get :: Get (Complex a) # putList :: [Complex a] -> Put #
Binary a => Binary (Identity a)
Instance details Defined in Data.Binary.Class Methods put :: Identity a -> Put # get :: Get (Identity a) # putList :: [Identity a] -> Put #
Binary a => Binary (First a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: First a -> Put # get :: Get (First a) # putList :: [First a] -> Put #
Binary a => Binary (Last a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Last a -> Put # get :: Get (Last a) # putList :: [Last a] -> Put #
Binary a => Binary (First a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: First a -> Put # get :: Get (First a) # putList :: [First a] -> Put #
Binary a => Binary (Last a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Last a -> Put # get :: Get (Last a) # putList :: [Last a] -> Put #
Binary a => Binary (Max a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Max a -> Put # get :: Get (Max a) # putList :: [Max a] -> Put #
Binary a => Binary (Min a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Min a -> Put # get :: Get (Min a) # putList :: [Min a] -> Put #
Binary m => Binary (WrappedMonoid m)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: WrappedMonoid m -> Put # get :: Get (WrappedMonoid m) # putList :: [WrappedMonoid m] -> Put #
Binary a => Binary (Dual a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Dual a -> Put # get :: Get (Dual a) # putList :: [Dual a] -> Put #
Binary a => Binary (Product a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Product a -> Put # get :: Get (Product a) # putList :: [Product a] -> Put #
Binary a => Binary (Sum a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Sum a -> Put # get :: Get (Sum a) # putList :: [Sum a] -> Put #
Binary a => Binary (NonEmpty a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: NonEmpty a -> Put # get :: Get (NonEmpty a) # putList :: [NonEmpty a] -> Put #
(Binary a, Integral a) => Binary (Ratio a)
Instance details Defined in Data.Binary.Class Methods put :: Ratio a -> Put # get :: Get (Ratio a) # putList :: [Ratio a] -> Put #
Binary e => Binary (IntMap e)
Instance details Defined in Data.Binary.Class Methods put :: IntMap e -> Put # get :: Get (IntMap e) # putList :: [IntMap e] -> Put #
Binary e => Binary (Seq e)
Instance details Defined in Data.Binary.Class Methods put :: Seq e -> Put # get :: Get (Seq e) # putList :: [Seq e] -> Put #
Binary a => Binary (Set a)
Instance details Defined in Data.Binary.Class Methods put :: Set a -> Put # get :: Get (Set a) # putList :: [Set a] -> Put #
Binary e => Binary (Tree e)
Instance details Defined in Data.Binary.Class Methods put :: Tree e -> Put # get :: Get (Tree e) # putList :: [Tree e] -> Put #
Binary a => Binary (Maybe a)
Instance details Defined in Data.Strict.Maybe Methods put :: Maybe a -> Put # get :: Get (Maybe a) # putList :: [Maybe a] -> Put #
Binary (Zp p) Source #
Instance details Defined in ZkFold.Base.Algebra.Basic.Field Methods put :: Zp p -> Put # get :: Get (Zp p) # putList :: [Zp p] -> Put #
Binary a => Binary (Maybe a)
Instance details Defined in Data.Binary.Class Methods put :: Maybe a -> Put # get :: Get (Maybe a) # putList :: [Maybe a] -> Put #
Binary a => Binary [a]
Instance details Defined in Data.Binary.Class Methods put :: [a] -> Put # get :: Get [a] # putList :: [[a]] -> Put #
(Binary i, Ix i, Binary e, IArray UArray e) => Binary (UArray i e)
Instance details Defined in Data.Binary.Class Methods put :: UArray i e -> Put # get :: Get (UArray i e) # putList :: [UArray i e] -> Put #
(Binary a, Binary b) => Binary (Either a b)
Instance details Defined in Data.Binary.Class Methods put :: Either a b -> Put # get :: Get (Either a b) # putList :: [Either a b] -> Put #
Binary (Fixed a)	Since: binary-0.8.0.0
Instance details Defined in Data.Binary.Class Methods put :: Fixed a -> Put # get :: Get (Fixed a) # putList :: [Fixed a] -> Put #
(Binary a, Binary b) => Binary (Arg a b)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Arg a b -> Put # get :: Get (Arg a b) # putList :: [Arg a b] -> Put #
Typeable a => Binary (TypeRep a)
Instance details Defined in Data.Binary.Class Methods put :: TypeRep a -> Put # get :: Get (TypeRep a) # putList :: [TypeRep a] -> Put #
(Binary i, Ix i, Binary e) => Binary (Array i e)
Instance details Defined in Data.Binary.Class Methods put :: Array i e -> Put # get :: Get (Array i e) # putList :: [Array i e] -> Put #
(Binary k, Binary e) => Binary (Map k e)
Instance details Defined in Data.Binary.Class Methods put :: Map k e -> Put # get :: Get (Map k e) # putList :: [Map k e] -> Put #
(Binary a, Binary b) => Binary (Either a b)
Instance details Defined in Data.Strict.Either Methods put :: Either a b -> Put # get :: Get (Either a b) # putList :: [Either a b] -> Put #
(Binary a, Binary b) => Binary (These a b)
Instance details Defined in Data.Strict.These Methods put :: These a b -> Put # get :: Get (These a b) # putList :: [These a b] -> Put #
(Binary a, Binary b) => Binary (Pair a b)
Instance details Defined in Data.Strict.Tuple Methods put :: Pair a b -> Put # get :: Get (Pair a b) # putList :: [Pair a b] -> Put #
(Binary a, Binary b) => Binary (These a b)	Since: these-0.7.1
Instance details Defined in Data.These Methods put :: These a b -> Put # get :: Get (These a b) # putList :: [These a b] -> Put #
Binary f => Binary (Ext2 f e) Source #
Instance details Defined in ZkFold.Base.Algebra.Basic.Field Methods put :: Ext2 f e -> Put # get :: Get (Ext2 f e) # putList :: [Ext2 f e] -> Put #
Binary f => Binary (Ext3 f e) Source #
Instance details Defined in ZkFold.Base.Algebra.Basic.Field Methods put :: Ext3 f e -> Put # get :: Get (Ext3 f e) # putList :: [Ext3 f e] -> Put #
(EllipticCurve curve, Binary (BaseField curve)) => Binary (Point curve) Source #
Instance details Defined in ZkFold.Base.Algebra.EllipticCurve.Class Methods put :: Point curve -> Put # get :: Get (Point curve) # putList :: [Point curve] -> Put #
(Binary a, KnownNat n) => Binary (SVector n a) Source #
Instance details Defined in ZkFold.Base.Data.Sparse.Vector Methods put :: SVector n a -> Put # get :: Get (SVector n a) # putList :: [SVector n a] -> Put #
Binary a => Binary (Vector n a) Source #
Instance details Defined in ZkFold.Base.Data.Vector Methods put :: Vector n a -> Put # get :: Get (Vector n a) # putList :: [Vector n a] -> Put #
(Binary a, Binary b) => Binary (a, b)
Instance details Defined in Data.Binary.Class Methods put :: (a, b) -> Put # get :: Get (a, b) # putList :: [(a, b)] -> Put #
Binary (f a) => Binary (Alt f a)	Since: binary-0.8.4.0
Instance details Defined in Data.Binary.Class Methods put :: Alt f a -> Put # get :: Get (Alt f a) # putList :: [Alt f a] -> Put #
(Binary c, Binary (ProverMessage t a)) => Binary (CommitOpenProverMessage t c a) Source #
Instance details Defined in ZkFold.Base.Protocol.ARK.Protostar.CommitOpen Methods put :: CommitOpenProverMessage t c a -> Put # get :: Get (CommitOpenProverMessage t c a) # putList :: [CommitOpenProverMessage t c a] -> Put #
(Binary a, Binary b, Binary c) => Binary (a, b, c)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c) -> Put # get :: Get (a, b, c) # putList :: [(a, b, c)] -> Put #
(Binary a, Binary b, Binary c, Binary d) => Binary (a, b, c, d)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d) -> Put # get :: Get (a, b, c, d) # putList :: [(a, b, c, d)] -> Put #
(Binary a, Binary b, Binary c, Binary d, Binary e) => Binary (a, b, c, d, e)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e) -> Put # get :: Get (a, b, c, d, e) # putList :: [(a, b, c, d, e)] -> Put #
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f) => Binary (a, b, c, d, e, f)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e, f) -> Put # get :: Get (a, b, c, d, e, f) # putList :: [(a, b, c, d, e, f)] -> Put #
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g) => Binary (a, b, c, d, e, f, g)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e, f, g) -> Put # get :: Get (a, b, c, d, e, f, g) # putList :: [(a, b, c, d, e, f, g)] -> Put #
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g, Binary h) => Binary (a, b, c, d, e, f, g, h)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e, f, g, h) -> Put # get :: Get (a, b, c, d, e, f, g, h) # putList :: [(a, b, c, d, e, f, g, h)] -> Put #
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g, Binary h, Binary i) => Binary (a, b, c, d, e, f, g, h, i)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e, f, g, h, i) -> Put # get :: Get (a, b, c, d, e, f, g, h, i) # putList :: [(a, b, c, d, e, f, g, h, i)] -> Put #
(Binary a, Binary b, Binary c, Binary d, Binary e, Binary f, Binary g, Binary h, Binary i, Binary j) => Binary (a, b, c, d, e, f, g, h, i, j)
Instance details Defined in Data.Binary.Class Methods put :: (a, b, c, d, e, f, g, h, i, j) -> Put # get :: Get (a, b, c, d, e, f, g, h, i, j) # putList :: [(a, b, c, d, e, f, g, h, i, j)] -> Put #

toByteString :: Binary a => a -> ByteString Source #

fromByteString :: Binary a => ByteString -> Maybe a Source #

putWord8 :: Word8 -> Put #

Efficiently write a byte into the output buffer

getWord8 :: Get Word8 #

Read a Word8 from the monad state

newtype LittleEndian Source #

Constructors

LittleEndian
Fields unLittleEndian :: Natural

Instances

Instances details

Enum LittleEndian Source #
Instance details Defined in ZkFold.Base.Data.ByteString Methods succ :: LittleEndian -> LittleEndian # pred :: LittleEndian -> LittleEndian # toEnum :: Int -> LittleEndian # fromEnum :: LittleEndian -> Int # enumFrom :: LittleEndian -> [LittleEndian] # enumFromThen :: LittleEndian -> LittleEndian -> [LittleEndian] # enumFromTo :: LittleEndian -> LittleEndian -> [LittleEndian] # enumFromThenTo :: LittleEndian -> LittleEndian -> LittleEndian -> [LittleEndian] #
Num LittleEndian Source #
Instance details Defined in ZkFold.Base.Data.ByteString Methods (+) :: LittleEndian -> LittleEndian -> LittleEndian # (-) :: LittleEndian -> LittleEndian -> LittleEndian # (*) :: LittleEndian -> LittleEndian -> LittleEndian # negate :: LittleEndian -> LittleEndian # abs :: LittleEndian -> LittleEndian # signum :: LittleEndian -> LittleEndian # fromInteger :: Integer -> LittleEndian #
Read LittleEndian Source #
Instance details Defined in ZkFold.Base.Data.ByteString Methods readsPrec :: Int -> ReadS LittleEndian # readList :: ReadS [LittleEndian] # readPrec :: ReadPrec LittleEndian # readListPrec :: ReadPrec [LittleEndian] #
Integral LittleEndian Source #
Instance details Defined in ZkFold.Base.Data.ByteString Methods quot :: LittleEndian -> LittleEndian -> LittleEndian # rem :: LittleEndian -> LittleEndian -> LittleEndian # div :: LittleEndian -> LittleEndian -> LittleEndian # mod :: LittleEndian -> LittleEndian -> LittleEndian # quotRem :: LittleEndian -> LittleEndian -> (LittleEndian, LittleEndian) # divMod :: LittleEndian -> LittleEndian -> (LittleEndian, LittleEndian) # toInteger :: LittleEndian -> Integer #
Real LittleEndian Source #
Instance details Defined in ZkFold.Base.Data.ByteString Methods toRational :: LittleEndian -> Rational #
Show LittleEndian Source #
Instance details Defined in ZkFold.Base.Data.ByteString Methods showsPrec :: Int -> LittleEndian -> ShowS # show :: LittleEndian -> String # showList :: [LittleEndian] -> ShowS #
Binary LittleEndian Source #
Instance details Defined in ZkFold.Base.Data.ByteString Methods put :: LittleEndian -> Put # get :: Get LittleEndian # putList :: [LittleEndian] -> Put #
Eq LittleEndian Source #
Instance details Defined in ZkFold.Base.Data.ByteString Methods (==) :: LittleEndian -> LittleEndian -> Bool # (/=) :: LittleEndian -> LittleEndian -> Bool #
Ord LittleEndian Source #
Instance details Defined in ZkFold.Base.Data.ByteString Methods compare :: LittleEndian -> LittleEndian -> Ordering # (<) :: LittleEndian -> LittleEndian -> Bool # (<=) :: LittleEndian -> LittleEndian -> Bool # (>) :: LittleEndian -> LittleEndian -> Bool # (>=) :: LittleEndian -> LittleEndian -> Bool # max :: LittleEndian -> LittleEndian -> LittleEndian # min :: LittleEndian -> LittleEndian -> LittleEndian #