bits-0.6: Various bit twiddling and bitwise serialization primitives
Copyright(c) Edward Kmett 2013
LicenseBSD3
MaintainerEdward Kmett <[email protected]>
Stabilityexperimental
Portabilitynon-portable
Safe HaskellSafe-Inferred
LanguageHaskell2010

Data.Bits.Coding

Contents

Description

 
Synopsis

Documentation

newtype Coding (m :: Type -> Type) a Source #

Constructors

Coding 

Fields

Instances

Instances details
MonadTrans Coding Source # 
Instance details

Defined in Data.Bits.Coding

Methods

lift :: Monad m => m a -> Coding m a #

MonadReader e m => MonadReader e (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

Methods

ask :: Coding m e #

local :: (e -> e) -> Coding m a -> Coding m a #

reader :: (e -> a) -> Coding m a #

MonadState s m => MonadState s (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

Methods

get :: Coding m s #

put :: s -> Coding m () #

state :: (s -> (a, s)) -> Coding m a #

MonadFail m => MonadFail (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

Methods

fail :: String -> Coding m a #

(Monad m, Alternative m) => Alternative (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

Methods

empty :: Coding m a #

(<|>) :: Coding m a -> Coding m a -> Coding m a #

some :: Coding m a -> Coding m [a] #

many :: Coding m a -> Coding m [a] #

Monad m => Applicative (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

Methods

pure :: a -> Coding m a #

(<*>) :: Coding m (a -> b) -> Coding m a -> Coding m b #

liftA2 :: (a -> b -> c) -> Coding m a -> Coding m b -> Coding m c #

(*>) :: Coding m a -> Coding m b -> Coding m b #

(<*) :: Coding m a -> Coding m b -> Coding m a #

Functor (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

Methods

fmap :: (a -> b) -> Coding m a -> Coding m b #

(<$) :: a -> Coding m b -> Coding m a #

Monad m => Monad (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

Methods

(>>=) :: Coding m a -> (a -> Coding m b) -> Coding m b #

(>>) :: Coding m a -> Coding m b -> Coding m b #

return :: a -> Coding m a #

MonadPlus m => MonadPlus (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

Methods

mzero :: Coding m a #

mplus :: Coding m a -> Coding m a -> Coding m a #

MonadGet m => MonadGet (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

Associated Types

type Remaining (Coding m) 
Instance details

Defined in Data.Bits.Coding

type Remaining (Coding m) = Remaining m
type Bytes (Coding m) 
Instance details

Defined in Data.Bits.Coding

type Bytes (Coding m) = Bytes m

Methods

skip :: Int -> Coding m () #

ensure :: Int -> Coding m ByteString #

lookAhead :: Coding m a -> Coding m a #

lookAheadM :: Coding m (Maybe a) -> Coding m (Maybe a) #

lookAheadE :: Coding m (Either a b) -> Coding m (Either a b) #

getBytes :: Int -> Coding m ByteString #

remaining :: Coding m (Remaining (Coding m)) #

isEmpty :: Coding m Bool #

getWord8 :: Coding m Word8 #

getByteString :: Int -> Coding m ByteString #

getLazyByteString :: Int64 -> Coding m ByteString #

getWord16be :: Coding m Word16 #

getWord16le :: Coding m Word16 #

getWord16host :: Coding m Word16 #

getWord32be :: Coding m Word32 #

getWord32le :: Coding m Word32 #

getWord32host :: Coding m Word32 #

getWord64be :: Coding m Word64 #

getWord64le :: Coding m Word64 #

getWord64host :: Coding m Word64 #

getWordhost :: Coding m Word #

MonadPut m => MonadPut (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

Methods

putWord8 :: Word8 -> Coding m () #

putByteString :: ByteString -> Coding m () #

putLazyByteString :: ByteString -> Coding m () #

flush :: Coding m () #

putWord16le :: Word16 -> Coding m () #

putWord16be :: Word16 -> Coding m () #

putWord16host :: Word16 -> Coding m () #

putWord32le :: Word32 -> Coding m () #

putWord32be :: Word32 -> Coding m () #

putWord32host :: Word32 -> Coding m () #

putWord64le :: Word64 -> Coding m () #

putWord64be :: Word64 -> Coding m () #

putWord64host :: Word64 -> Coding m () #

putWordhost :: Word -> Coding m () #

type Bytes (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

type Bytes (Coding m) = Bytes m
type Remaining (Coding m) Source # 
Instance details

Defined in Data.Bits.Coding

type Remaining (Coding m) = Remaining m

Get

getAligned :: MonadGet m => m a -> Coding m a Source #

Get something from byte-aligned storage, starting on the next byte and discarding any left over bits in the buffer.

NB: Using any operation from MonadGet other than checking remaining or isEmpty will implicitly perform this operation.

getBit :: forall (m :: Type -> Type). MonadGet m => Coding m Bool Source #

Get a single bit, consuming an entire byte if the bit buffer is empty

getBits :: forall (m :: Type -> Type) b. (MonadGet m, Bits b) => Int -> Int -> b -> Coding m b Source #

getBitsFrom :: forall (m :: Type -> Type) b. (MonadGet m, Bits b) => Int -> b -> Coding m b Source #

Put

putAligned :: MonadPut m => m a -> Coding m a Source #

Emit any remaining contents from the bit buffer.

Any use of the combinators from MonadPut (including flush) will cause this to happen.

putUnaligned :: forall (m :: Type -> Type) b. (MonadPut m, FiniteBits b) => b -> Coding m () Source #

Put all the bits without a flush

putBit :: forall (m :: Type -> Type). MonadPut m => Bool -> Coding m () Source #

Put a single bit, emitting an entire byte if the bit buffer is full

putBits :: forall (m :: Type -> Type) b. (MonadPut m, Bits b) => Int -> Int -> b -> Coding m () Source #

Put a (closed) range of bits

putBitsFrom :: forall (m :: Type -> Type) b. (MonadPut m, Bits b) => Int -> b -> Coding m () Source #

putBitsFrom from b = putBits from 0 b