Flat.Filler

Pre-value and post-value byte alignments

Documentation

data Filler

A meaningless sequence of 0 bits terminated with a 1 bit (easier to implement than the reverse) Useful to align an encoded value at byte/word boundaries.

Constructors

FillerBit Filler

FillerEnd

Instances

Eq Filler

Defined in Flat.Filler

Methods

(==) :: Filler -> Filler -> Bool

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

Ord Filler

Defined in Flat.Filler

Methods

compare :: Filler -> Filler -> Ordering

(<) :: Filler -> Filler -> Bool

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

(>) :: Filler -> Filler -> Bool

(>=) :: Filler -> Filler -> Bool

max :: Filler -> Filler -> Filler

min :: Filler -> Filler -> Filler

Show Filler

Defined in Flat.Filler

Methods

showsPrec :: Int -> Filler -> ShowS

show :: Filler -> String

showList :: [Filler] -> ShowS

Generic Filler

Defined in Flat.Filler

Associated Types

type Rep Filler :: Type -> Type

Methods

from :: Filler -> Rep Filler x

to :: Rep Filler x -> Filler

NFData Filler

Defined in Flat.Filler

Methods

rnf :: Filler -> ()

Flat Filler

Use a special encoding for the filler

Defined in Flat.Filler

Methods

encode :: Filler -> Encoding

decode :: Get Filler

size :: Filler -> NumBits -> NumBits

type Rep Filler

Defined in Flat.Filler

type Rep Filler = D1 (MetaData "Filler" "Flat.Filler" "flat-0.4.4-FeVyhxo3HGG15yLcuMeV64" False) (C1 (MetaCons "FillerBit" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Filler)) :+: C1 (MetaCons "FillerEnd" PrefixI False) (U1 :: Type -> Type))

fillerLength :: Num a => Filler -> a

Length of a filler in bits

data PreAligned a

A Pre aligned value, a value preceded by a filler Useful to prealign ByteArrays, Texts and any structure that can be encoded more efficiently when byte aligned.

Constructors

PreAligned

Fields

• preFiller :: Filler
• preValue :: a

Instances

Eq a => Eq (PreAligned a)

Defined in Flat.Filler

Methods

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

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

Ord a => Ord (PreAligned a)

Defined in Flat.Filler

Methods

compare :: PreAligned a -> PreAligned a -> Ordering

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

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

(>) :: PreAligned a -> PreAligned a -> Bool

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

max :: PreAligned a -> PreAligned a -> PreAligned a

min :: PreAligned a -> PreAligned a -> PreAligned a

Show a => Show (PreAligned a)

Defined in Flat.Filler

Methods

showsPrec :: Int -> PreAligned a -> ShowS

show :: PreAligned a -> String

showList :: [PreAligned a] -> ShowS

Generic (PreAligned a)

Defined in Flat.Filler

Associated Types

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

Methods

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

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

NFData a => NFData (PreAligned a)

Defined in Flat.Filler

Methods

rnf :: PreAligned a -> ()

Flat a => Flat (PreAligned a)

Defined in Flat.Filler

Methods

encode :: PreAligned a -> Encoding

decode :: Get (PreAligned a)

size :: PreAligned a -> NumBits -> NumBits

type Rep (PreAligned a)

Defined in Flat.Filler

type Rep (PreAligned a) = D1 (MetaData "PreAligned" "Flat.Filler" "flat-0.4.4-FeVyhxo3HGG15yLcuMeV64" False) (C1 (MetaCons "PreAligned" PrefixI True) (S1 (MetaSel (Just "preFiller") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Filler) :*: S1 (MetaSel (Just "preValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))

preAligned :: a -> PreAligned a

Pre align a value

data PostAligned a

A Post aligned value, a value followed by a filler Useful to complete the encoding of a top-level value

Constructors

PostAligned

Fields

• postValue :: a
• postFiller :: Filler

Instances

Eq a => Eq (PostAligned a)

Defined in Flat.Filler

Methods

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

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

Ord a => Ord (PostAligned a)

Defined in Flat.Filler

Methods

compare :: PostAligned a -> PostAligned a -> Ordering

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

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

(>) :: PostAligned a -> PostAligned a -> Bool

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

max :: PostAligned a -> PostAligned a -> PostAligned a

min :: PostAligned a -> PostAligned a -> PostAligned a

Show a => Show (PostAligned a)

Defined in Flat.Filler

Methods

showsPrec :: Int -> PostAligned a -> ShowS

show :: PostAligned a -> String

showList :: [PostAligned a] -> ShowS

Generic (PostAligned a)

Defined in Flat.Filler

Associated Types

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

Methods

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

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

NFData a => NFData (PostAligned a)

Defined in Flat.Filler

Methods

rnf :: PostAligned a -> ()

Flat a => Flat (PostAligned a)

Defined in Flat.Filler

Methods

encode :: PostAligned a -> Encoding

decode :: Get (PostAligned a)

size :: PostAligned a -> NumBits -> NumBits

type Rep (PostAligned a)

Defined in Flat.Filler

type Rep (PostAligned a) = D1 (MetaData "PostAligned" "Flat.Filler" "flat-0.4.4-FeVyhxo3HGG15yLcuMeV64" False) (C1 (MetaCons "PostAligned" PrefixI True) (S1 (MetaSel (Just "postValue") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a) :*: S1 (MetaSel (Just "postFiller") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Filler)))

postAligned :: a -> PostAligned a

Post align a value

postAlignedDecoder :: Get b -> Get b

Decode a value assuming that is PostAligned