flat-0.4.4.0.0.0.0.2: Principled and efficient bit-oriented binary serialization.
Safe Haskell None
Language Haskell2010

Flat.Types

Description

Common Types

Synopsis

Documentation

type NumBits = Int Source #

Number of bits

module Data.Word

module Data.Int

data Natural Source #

Type representing arbitrary-precision non-negative integers. 

>>> 2^100 :: Natural
1267650600228229401496703205376

Operations whose result would be negative throw ( Underflow :: ArithException ) , 

>>> -1 :: Natural
*** Exception: arithmetic underflow

Since: base-4.8.0.0

Instances

Instances details
Enum Natural

Since: base-4.8.0.0

Instance details

Defined in GHC.Enum

Methods

succ :: Natural -> Natural Source #

pred :: Natural -> Natural Source #

toEnum :: Int -> Natural Source #

fromEnum :: Natural -> Int Source #

enumFrom :: Natural -> [ Natural ] Source #

enumFromThen :: Natural -> Natural -> [ Natural ] Source #

enumFromTo :: Natural -> Natural -> [ Natural ] Source #

enumFromThenTo :: Natural -> Natural -> Natural -> [ Natural ] Source #

Eq Natural

Since: base-4.8.0.0

Instance details

Defined in GHC.Natural

Methods

(==) :: Natural -> Natural -> Bool Source #

(/=) :: Natural -> Natural -> Bool Source #

Integral Natural

Since: base-4.8.0.0

Instance details

Defined in GHC.Real

Methods

quot :: Natural -> Natural -> Natural Source #

rem :: Natural -> Natural -> Natural Source #

div :: Natural -> Natural -> Natural Source #

mod :: Natural -> Natural -> Natural Source #

quotRem :: Natural -> Natural -> ( Natural , Natural ) Source #

divMod :: Natural -> Natural -> ( Natural , Natural ) Source #

toInteger :: Natural -> Integer Source #

Num Natural

Note that Natural 's Num instance isn't a ring: no element but 0 has an additive inverse. It is a semiring though.

Since: base-4.8.0.0

Instance details

Defined in GHC.Num

Methods

(+) :: Natural -> Natural -> Natural Source #

(-) :: Natural -> Natural -> Natural Source #

(*) :: Natural -> Natural -> Natural Source #

negate :: Natural -> Natural Source #

abs :: Natural -> Natural Source #

signum :: Natural -> Natural Source #

fromInteger :: Integer -> Natural Source #

Ord Natural

Since: base-4.8.0.0

Instance details

Defined in GHC.Natural

Methods

compare :: Natural -> Natural -> Ordering Source #

(<) :: Natural -> Natural -> Bool Source #

(<=) :: Natural -> Natural -> Bool Source #

(>) :: Natural -> Natural -> Bool Source #

(>=) :: Natural -> Natural -> Bool Source #

max :: Natural -> Natural -> Natural Source #

min :: Natural -> Natural -> Natural Source #

Read Natural

Since: base-4.8.0.0

Instance details

Defined in GHC.Read

Methods

readsPrec :: Int -> ReadS Natural Source #

readList :: ReadS [ Natural ] Source #

readPrec :: ReadPrec Natural Source #

readListPrec :: ReadPrec [ Natural ] Source #

Real Natural

Since: base-4.8.0.0

Instance details

Defined in GHC.Real

Methods

toRational :: Natural -> Rational Source #

Show Natural

Since: base-4.8.0.0

Instance details

Defined in GHC.Show

Methods

showsPrec :: Int -> Natural -> ShowS Source #

show :: Natural -> String Source #

showList :: [ Natural ] -> ShowS Source #

Ix Natural

Since: base-4.8.0.0

Instance details

Defined in GHC.Ix

Methods

range :: ( Natural , Natural ) -> [ Natural ] Source #

index :: ( Natural , Natural ) -> Natural -> Int Source #

unsafeIndex :: ( Natural , Natural ) -> Natural -> Int Source #

inRange :: ( Natural , Natural ) -> Natural -> Bool Source #

rangeSize :: ( Natural , Natural ) -> Int Source #

unsafeRangeSize :: ( Natural , Natural ) -> Int Source #

Bits Natural

Since: base-4.8.0

Instance details

Defined in Data.Bits

Methods

(.&.) :: Natural -> Natural -> Natural Source #

(.|.) :: Natural -> Natural -> Natural Source #

xor :: Natural -> Natural -> Natural Source #

complement :: Natural -> Natural Source #

shift :: Natural -> Int -> Natural Source #

rotate :: Natural -> Int -> Natural Source #

zeroBits :: Natural Source #

bit :: Int -> Natural Source #

setBit :: Natural -> Int -> Natural Source #

clearBit :: Natural -> Int -> Natural Source #

complementBit :: Natural -> Int -> Natural Source #

testBit :: Natural -> Int -> Bool Source #

bitSizeMaybe :: Natural -> Maybe Int Source #

bitSize :: Natural -> Int Source #

isSigned :: Natural -> Bool Source #

shiftL :: Natural -> Int -> Natural Source #

unsafeShiftL :: Natural -> Int -> Natural Source #

shiftR :: Natural -> Int -> Natural Source #

unsafeShiftR :: Natural -> Int -> Natural Source #

rotateL :: Natural -> Int -> Natural Source #

rotateR :: Natural -> Int -> Natural Source #

popCount :: Natural -> Int Source #

NFData Natural

Since: deepseq-1.4.0.0

Instance details

Defined in Control.DeepSeq

Methods

rnf :: Natural -> () Source #

Hashable Natural
Instance details

Defined in Data.Hashable.Class

Methods

hashWithSalt :: Int -> Natural -> Int Source #

hash :: Natural -> Int Source #

UniformRange Natural
Instance details

Defined in System.Random.Internal

Methods

uniformRM :: StatefulGen g m => ( Natural , Natural ) -> g -> m Natural Source #

Flat Natural Source #

Naturals are encoded just as the fixed size Words. 

>>> test (0::Natural)
(True,8,"00000000")

>>> test (2^120::Natural)
(True,144,"10000000 10000000 10000000 10000000 10000000 10000000 10000000 10000000 10000000 10000000 10000000 10000000 10000000 10000000 10000000 10000000 10000000 00000010")
Instance details

Defined in Flat.Instances.Base

Methods

encode :: Natural -> Encoding Source #

decode :: Get Natural Source #

size :: Natural -> NumBits -> NumBits Source #

Lift Natural
Instance details

Defined in Language.Haskell.TH.Syntax

Methods

lift :: Natural -> Q Exp Source #

liftTyped :: Natural -> Q ( TExp Natural ) Source #

ZigZag Integer Natural Source #
Instance details

Defined in Data.ZigZag

Methods

zigZag :: Integer -> Natural Source #

zagZig :: Natural -> Integer Source #

data ShortByteString Source #

A compact representation of a Word8 vector.

It has a lower memory overhead than a ByteString and does not contribute to heap fragmentation. It can be converted to or from a ByteString (at the cost of copying the string data). It supports very few other operations.

It is suitable for use as an internal representation for code that needs to keep many short strings in memory, but it should not be used as an interchange type. That is, it should not generally be used in public APIs. The ByteString type is usually more suitable for use in interfaces; it is more flexible and it supports a wide range of operations.

Instances

Instances details
IsList ShortByteString

Since: bytestring-0.10.12.0

Instance details

Defined in Data.ByteString.Short.Internal

Associated Types

type Item ShortByteString Source #

Methods

fromList :: [ Item ShortByteString ] -> ShortByteString Source #

fromListN :: Int -> [ Item ShortByteString ] -> ShortByteString Source #

toList :: ShortByteString -> [ Item ShortByteString ] Source #

Eq ShortByteString
Instance details

Defined in Data.ByteString.Short.Internal

Methods

(==) :: ShortByteString -> ShortByteString -> Bool Source #

(/=) :: ShortByteString -> ShortByteString -> Bool Source #

Data ShortByteString
Instance details

Defined in Data.ByteString.Short.Internal

Methods

gfoldl :: ( forall d b. Data d => c (d -> b) -> d -> c b) -> ( forall g. g -> c g) -> ShortByteString -> c ShortByteString Source #

gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ShortByteString Source #

toConstr :: ShortByteString -> Constr Source #

dataTypeOf :: ShortByteString -> DataType Source #

dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ShortByteString ) Source #

dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ShortByteString ) Source #

gmapT :: ( forall b. Data b => b -> b) -> ShortByteString -> ShortByteString Source #

gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> ShortByteString -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> ShortByteString -> r Source #

gmapQ :: ( forall d. Data d => d -> u) -> ShortByteString -> [u] Source #

gmapQi :: Int -> ( forall d. Data d => d -> u) -> ShortByteString -> u Source #

gmapM :: Monad m => ( forall d. Data d => d -> m d) -> ShortByteString -> m ShortByteString Source #

gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> ShortByteString -> m ShortByteString Source #

gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> ShortByteString -> m ShortByteString Source #

Ord ShortByteString
Instance details

Defined in Data.ByteString.Short.Internal

Methods

compare :: ShortByteString -> ShortByteString -> Ordering Source #

(<) :: ShortByteString -> ShortByteString -> Bool Source #

(<=) :: ShortByteString -> ShortByteString -> Bool Source #

(>) :: ShortByteString -> ShortByteString -> Bool Source #

(>=) :: ShortByteString -> ShortByteString -> Bool Source #

max :: ShortByteString -> ShortByteString -> ShortByteString Source #

min :: ShortByteString -> ShortByteString -> ShortByteString Source #

Read ShortByteString
Instance details

Defined in Data.ByteString.Short.Internal

Methods

readsPrec :: Int -> ReadS ShortByteString Source #

readList :: ReadS [ ShortByteString ] Source #

readPrec :: ReadPrec ShortByteString Source #

readListPrec :: ReadPrec [ ShortByteString ] Source #

Show ShortByteString
Instance details

Defined in Data.ByteString.Short.Internal

Methods

showsPrec :: Int -> ShortByteString -> ShowS Source #

show :: ShortByteString -> String Source #

showList :: [ ShortByteString ] -> ShowS Source #

IsString ShortByteString

Beware: fromString truncates multi-byte characters to octets. e.g. "枯朶に烏のとまりけり秋の暮" becomes �6k�nh~�Q��n�

Instance details

Defined in Data.ByteString.Short.Internal

Methods

fromString :: String -> ShortByteString Source #

Semigroup ShortByteString
Instance details

Defined in Data.ByteString.Short.Internal

Methods

(<>) :: ShortByteString -> ShortByteString -> ShortByteString Source #

sconcat :: NonEmpty ShortByteString -> ShortByteString Source #

stimes :: Integral b => b -> ShortByteString -> ShortByteString Source #

Monoid ShortByteString
Instance details

Defined in Data.ByteString.Short.Internal

Methods

mempty :: ShortByteString Source #

mappend :: ShortByteString -> ShortByteString -> ShortByteString Source #

mconcat :: [ ShortByteString ] -> ShortByteString Source #

NFData ShortByteString
Instance details

Defined in Data.ByteString.Short.Internal

Methods

rnf :: ShortByteString -> () Source #

Hashable ShortByteString
Instance details

Defined in Data.Hashable.Class

Methods

hashWithSalt :: Int -> ShortByteString -> Int Source #

hash :: ShortByteString -> Int Source #

Flat ShortByteString Source # 
>>> tst ((False,True,False,SBS.pack [11,22,33]))
(True,51,[65,3,11,22,33,0])
Instance details

Defined in Flat.Instances.ByteString

Methods

encode :: ShortByteString -> Encoding Source #

decode :: Get ShortByteString Source #

size :: ShortByteString -> NumBits -> NumBits Source #

type Item ShortByteString
Instance details

Defined in Data.ByteString.Short.Internal

type Item ShortByteString = Word8

data Text Source #

A space efficient, packed, unboxed Unicode text type.

Instances

Instances details
Hashable Text
Instance details

Defined in Data.Hashable.Class

Methods

hashWithSalt :: Int -> Text -> Int Source #

hash :: Text -> Int Source #

SemiSequence Text
Instance details

Defined in Data.Sequences

Associated Types

type Index Text Source #

Methods

intersperse :: Element Text -> Text -> Text Source #

reverse :: Text -> Text Source #

find :: ( Element Text -> Bool ) -> Text -> Maybe ( Element Text ) Source #

sortBy :: ( Element Text -> Element Text -> Ordering ) -> Text -> Text Source #

cons :: Element Text -> Text -> Text Source #

snoc :: Text -> Element Text -> Text Source #

IsSequence Text
Instance details

Defined in Data.Sequences

Methods

fromList :: [ Element Text ] -> Text Source #

lengthIndex :: Text -> Index Text Source #

break :: ( Element Text -> Bool ) -> Text -> ( Text , Text ) Source #

span :: ( Element Text -> Bool ) -> Text -> ( Text , Text ) Source #

dropWhile :: ( Element Text -> Bool ) -> Text -> Text Source #

takeWhile :: ( Element Text -> Bool ) -> Text -> Text Source #

splitAt :: Index Text -> Text -> ( Text , Text ) Source #

unsafeSplitAt :: Index Text -> Text -> ( Text , Text ) Source #

take :: Index Text -> Text -> Text Source #

unsafeTake :: Index Text -> Text -> Text Source #

drop :: Index Text -> Text -> Text Source #

unsafeDrop :: Index Text -> Text -> Text Source #

dropEnd :: Index Text -> Text -> Text Source #

partition :: ( Element Text -> Bool ) -> Text -> ( Text , Text ) Source #

uncons :: Text -> Maybe ( Element Text , Text ) Source #

unsnoc :: Text -> Maybe ( Text , Element Text ) Source #

filter :: ( Element Text -> Bool ) -> Text -> Text Source #

filterM :: Monad m => ( Element Text -> m Bool ) -> Text -> m Text Source #

replicate :: Index Text -> Element Text -> Text Source #

replicateM :: Monad m => Index Text -> m ( Element Text ) -> m Text Source #

groupBy :: ( Element Text -> Element Text -> Bool ) -> Text -> [ Text ] Source #

groupAllOn :: Eq b => ( Element Text -> b) -> Text -> [ Text ] Source #

subsequences :: Text -> [ Text ] Source #

permutations :: Text -> [ Text ] Source #

tailEx :: Text -> Text Source #

tailMay :: Text -> Maybe Text Source #

initEx :: Text -> Text Source #

initMay :: Text -> Maybe Text Source #

unsafeTail :: Text -> Text Source #

unsafeInit :: Text -> Text Source #

index :: Text -> Index Text -> Maybe ( Element Text ) Source #

indexEx :: Text -> Index Text -> Element Text Source #

unsafeIndex :: Text -> Index Text -> Element Text Source #

splitWhen :: ( Element Text -> Bool ) -> Text -> [ Text ] Source #

Textual Text
Instance details

Defined in Data.Sequences

Methods

words :: Text -> [ Text ] Source #

unwords :: ( Element seq ~ Text , MonoFoldable seq) => seq -> Text Source #

lines :: Text -> [ Text ] Source #

unlines :: ( Element seq ~ Text , MonoFoldable seq) => seq -> Text Source #

toLower :: Text -> Text Source #

toUpper :: Text -> Text Source #

toCaseFold :: Text -> Text Source #

breakWord :: Text -> ( Text , Text ) Source #

breakLine :: Text -> ( Text , Text ) Source #

MonoZip Text
Instance details

Defined in Data.Containers

Methods

ozipWith :: ( Element Text -> Element Text -> Element Text ) -> Text -> Text -> Text Source #

ozip :: Text -> Text -> [( Element Text , Element Text )] Source #

ounzip :: [( Element Text , Element Text )] -> ( Text , Text ) Source #

MonoFunctor Text
Instance details

Defined in Data.MonoTraversable

Methods

omap :: ( Element Text -> Element Text ) -> Text -> Text Source #

MonoFoldable Text
Instance details

Defined in Data.MonoTraversable

Methods

ofoldMap :: Monoid m => ( Element Text -> m) -> Text -> m Source #

ofoldr :: ( Element Text -> b -> b) -> b -> Text -> b Source #

ofoldl' :: (a -> Element Text -> a) -> a -> Text -> a Source #

otoList :: Text -> [ Element Text ] Source #

oall :: ( Element Text -> Bool ) -> Text -> Bool Source #

oany :: ( Element Text -> Bool ) -> Text -> Bool Source #

onull :: Text -> Bool Source #

olength :: Text -> Int Source #

olength64 :: Text -> Int64 Source #

ocompareLength :: Integral i => Text -> i -> Ordering Source #

otraverse_ :: Applicative f => ( Element Text -> f b) -> Text -> f () Source #

ofor_ :: Applicative f => Text -> ( Element Text -> f b) -> f () Source #

omapM_ :: Applicative m => ( Element Text -> m ()) -> Text -> m () Source #

oforM_ :: Applicative m => Text -> ( Element Text -> m ()) -> m () Source #

ofoldlM :: Monad m => (a -> Element Text -> m a) -> a -> Text -> m a Source #

ofoldMap1Ex :: Semigroup m => ( Element Text -> m) -> Text -> m Source #

ofoldr1Ex :: ( Element Text -> Element Text -> Element Text ) -> Text -> Element Text Source #

ofoldl1Ex' :: ( Element Text -> Element Text -> Element Text ) -> Text -> Element Text Source #

headEx :: Text -> Element Text Source #

lastEx :: Text -> Element Text Source #

unsafeHead :: Text -> Element Text Source #

unsafeLast :: Text -> Element Text Source #

maximumByEx :: ( Element Text -> Element Text -> Ordering ) -> Text -> Element Text Source #

minimumByEx :: ( Element Text -> Element Text -> Ordering ) -> Text -> Element Text Source #

oelem :: Element Text -> Text -> Bool Source #

onotElem :: Element Text -> Text -> Bool Source #

MonoTraversable Text
Instance details

Defined in Data.MonoTraversable

Methods

otraverse :: Applicative f => ( Element Text -> f ( Element Text )) -> Text -> f Text Source #

omapM :: Applicative m => ( Element Text -> m ( Element Text )) -> Text -> m Text Source #

MonoPointed Text
Instance details

Defined in Data.MonoTraversable

Methods

opoint :: Element Text -> Text Source #

GrowingAppend Text
Instance details

Defined in Data.MonoTraversable

Flat Text Source #

Text (and Data.Text.Lazy) is encoded as a byte aligned array of bytes corresponding to its UTF8 encoding. 

>>> tst $ T.pack ""
(True,16,[1,0])

>>> tst $ T.pack "aaa"
(True,120,[1,3,97,97,97,0])

>>> tst $ T.pack "¢¢¢"
(True,120,[1,6,194,162,194,162,194,162,0])

>>> tst $ T.pack "日日日"
(True,120,[1,9,230,151,165,230,151,165,230,151,165,0])

>>> tst $ T.pack "𐍈𐍈𐍈"
(True,120,[1,12,240,144,141,136,240,144,141,136,240,144,141,136,0])

Strict and Lazy Text has the same encoding: 

>>> tst (T.pack "abc") == tst (TL.pack "abc")
True
Instance details

Defined in Flat.Instances.Text

Methods

encode :: Text -> Encoding Source #

decode :: Get Text Source #

size :: Text -> NumBits -> NumBits Source #

LazySequence Text Text
Instance details

Defined in Data.Sequences

Methods

toChunks :: Text -> [ Text0 ] Source #

fromChunks :: [ Text0 ] -> Text Source #

toStrict :: Text -> Text0 Source #

fromStrict :: Text0 -> Text Source #

Utf8 Text ByteString
Instance details

Defined in Data.Sequences

Methods

encodeUtf8 :: Text -> ByteString Source #

decodeUtf8 :: ByteString -> Text Source #

type Item Text
Instance details

Defined in Data.Text

type Item Text = Char
type Index Text
Instance details

Defined in Data.Sequences

type Index Text = Int
type Element Text
Instance details

Defined in Data.MonoTraversable

type Element Text = Char