ZM.BLOB

Documentation

data BLOB encoding

A BLOB is binary value encoded according to a specified encoding (e.g. UTF8)

Constructors

BLOB

Fields

• encoding :: encoding
• content :: ByteString

Instances

Eq encoding => Eq (BLOB encoding)

Methods

(==) :: BLOB encoding -> BLOB encoding -> Bool

(/=) :: BLOB encoding -> BLOB encoding -> Bool

Ord encoding => Ord (BLOB encoding)

Methods

compare :: BLOB encoding -> BLOB encoding -> Ordering

(<) :: BLOB encoding -> BLOB encoding -> Bool

(<=) :: BLOB encoding -> BLOB encoding -> Bool

(>) :: BLOB encoding -> BLOB encoding -> Bool

(>=) :: BLOB encoding -> BLOB encoding -> Bool

max :: BLOB encoding -> BLOB encoding -> BLOB encoding

min :: BLOB encoding -> BLOB encoding -> BLOB encoding

Show encoding => Show (BLOB encoding)

Methods

showsPrec :: Int -> BLOB encoding -> ShowS

show :: BLOB encoding -> String

showList :: [BLOB encoding] -> ShowS

Generic (BLOB encoding)

Associated Types

type Rep (BLOB encoding) :: * -> *

Methods

from :: BLOB encoding -> Rep (BLOB encoding) x

to :: Rep (BLOB encoding) x -> BLOB encoding

NFData encoding => NFData (BLOB encoding)

Methods

rnf :: BLOB encoding -> ()

Flat encoding => Flat (BLOB encoding)

Methods

encode :: BLOB encoding -> Encoding

decode :: Get (BLOB encoding)

size :: BLOB encoding -> NumBits -> NumBits

Model encoding => Model (BLOB encoding)

Methods

envType :: Proxy * (BLOB encoding) -> State Env HType

type Rep (BLOB encoding)

type Rep (BLOB encoding) = D1 (MetaData "BLOB" "ZM.BLOB" "zm-0.3.1-EJXilV2Uyeu4Fp3o0Acy4f" False) (C1 (MetaCons "BLOB" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "encoding") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 encoding)) (S1 (MetaSel (Just Symbol "content") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString))))

blob :: AsByteString a => encoding -> a -> BLOB encoding

Build a BLOB from an encoding and a ByteString-like value

unblob :: BLOB t -> ByteString

Extract the binary content of a BLOB

data TypedBLOB

A typed value, a Flat encoded value and its absolute type

Constructors

TypedBLOB AbsType (BLOB FlatEncoding)

Instances

Eq TypedBLOB

Methods

(==) :: TypedBLOB -> TypedBLOB -> Bool

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

Ord TypedBLOB

Methods

compare :: TypedBLOB -> TypedBLOB -> Ordering

(<) :: TypedBLOB -> TypedBLOB -> Bool

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

(>) :: TypedBLOB -> TypedBLOB -> Bool

(>=) :: TypedBLOB -> TypedBLOB -> Bool

max :: TypedBLOB -> TypedBLOB -> TypedBLOB

min :: TypedBLOB -> TypedBLOB -> TypedBLOB

Show TypedBLOB

Methods

showsPrec :: Int -> TypedBLOB -> ShowS

show :: TypedBLOB -> String

showList :: [TypedBLOB] -> ShowS

Generic TypedBLOB

Associated Types

type Rep TypedBLOB :: * -> *

Methods

from :: TypedBLOB -> Rep TypedBLOB x

to :: Rep TypedBLOB x -> TypedBLOB

NFData TypedBLOB

Methods

rnf :: TypedBLOB -> ()

Flat TypedBLOB

Methods

encode :: TypedBLOB -> Encoding

decode :: Get TypedBLOB

size :: TypedBLOB -> NumBits -> NumBits

Model TypedBLOB

Methods

envType :: Proxy * TypedBLOB -> State Env HType

type Rep TypedBLOB

type Rep TypedBLOB = D1 (MetaData "TypedBLOB" "ZM.BLOB" "zm-0.3.1-EJXilV2Uyeu4Fp3o0Acy4f" False) (C1 (MetaCons "TypedBLOB" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbsType)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (BLOB FlatEncoding)))))

typedBLOB :: forall a. (Model a, Flat a) => a -> TypedBLOB

Build a TypedBLOB out of a value

typedBLOB_ :: Flat a => AbsType -> a -> TypedBLOB

Build a TypedBLOB out of a type and a value

untypedBLOB :: forall a. (Flat a, Model a) => Decoded TypedBLOB -> TypedDecoded a

Type-checked extraction of a value of a known type from a decoded TypedBLOB

data TypedValue a

A typed value, a value and its absolute type

Constructors

TypedValue AbsType a

Instances

Functor TypedValue

Methods

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

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

Eq a => Eq (TypedValue a)

Methods

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

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

Ord a => Ord (TypedValue a)

Methods

compare :: TypedValue a -> TypedValue a -> Ordering

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

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

(>) :: TypedValue a -> TypedValue a -> Bool

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

max :: TypedValue a -> TypedValue a -> TypedValue a

min :: TypedValue a -> TypedValue a -> TypedValue a

Show a => Show (TypedValue a)

Methods

showsPrec :: Int -> TypedValue a -> ShowS

show :: TypedValue a -> String

showList :: [TypedValue a] -> ShowS

Generic (TypedValue a)

Associated Types

type Rep (TypedValue a) :: * -> *

Methods

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

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

NFData a => NFData (TypedValue a)

Methods

rnf :: TypedValue a -> ()

Flat a => Flat (TypedValue a)

Methods

encode :: TypedValue a -> Encoding

decode :: Get (TypedValue a)

size :: TypedValue a -> NumBits -> NumBits

type Rep (TypedValue a)

type Rep (TypedValue a) = D1 (MetaData "TypedValue" "ZM.BLOB" "zm-0.3.1-EJXilV2Uyeu4Fp3o0Acy4f" False) (C1 (MetaCons "TypedValue" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AbsType)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))

typedValue :: forall a. Model a => a -> TypedValue a

Build a TypedValue out of a value

untypedValue :: Model a => Decoded (TypedValue a) -> TypedDecoded a

Type-checked extraction of a value of a known type from a decoded TypedValue

typeErr :: AbsType -> AbsType -> TypedDecoded a

Return a WrongType error