Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.GstBase.Structs.BitReader

Contents

Exported types
Methods
Properties
- bit
- byte
- size

Description

BitReader provides a bit reader that can read any number of bits from a memory buffer. It provides functions for reading any number of bits into 8, 16, 32 and 64 bit variables.

Synopsis

Exported types

newtype BitReader Source #

Constructors

BitReader (ManagedPtr BitReader)

Instances

WrappedPtr BitReader Source #
Methods wrappedPtrCalloc :: IO (Ptr BitReader) # wrappedPtrCopy :: BitReader -> IO BitReader # wrappedPtrFree :: Maybe (FunPtr (Ptr BitReader -> IO ())) #
(~) AttrOpTag tag AttrSet => Constructible BitReader tag Source #
Methods new :: MonadIO m => (ManagedPtr BitReader -> BitReader) -> [AttrOp BitReader tag] -> m BitReader #
((~) * info (ResolveBitReaderMethod t BitReader), MethodInfo * info BitReader p) => IsLabel t (BitReader -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> BitReader -> p #
((~) * info (ResolveBitReaderMethod t BitReader), MethodInfo * info BitReader p) => IsLabelProxy t (BitReader -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> BitReader -> p #
HasAttributeList * BitReader Source #

((~) * signature (m Bool), MonadIO m) => MethodInfo * BitReaderSkipToByteMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderSkipToByteMethodInfo BitReader -> signature -> s #
((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * BitReaderSkipMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderSkipMethodInfo BitReader -> signature -> s #
((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * BitReaderSetPosMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderSetPosMethodInfo BitReader -> signature -> s #
((~) * signature (Word32 -> m (Bool, Word8)), MonadIO m) => MethodInfo * BitReaderPeekBitsUint8MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderPeekBitsUint8MethodInfo BitReader -> signature -> s #
((~) * signature (Word32 -> m (Bool, Word64)), MonadIO m) => MethodInfo * BitReaderPeekBitsUint64MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderPeekBitsUint64MethodInfo BitReader -> signature -> s #
((~) * signature (Word32 -> m (Bool, Word32)), MonadIO m) => MethodInfo * BitReaderPeekBitsUint32MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderPeekBitsUint32MethodInfo BitReader -> signature -> s #
((~) * signature (Word32 -> m (Bool, Word16)), MonadIO m) => MethodInfo * BitReaderPeekBitsUint16MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderPeekBitsUint16MethodInfo BitReader -> signature -> s #
((~) * signature (ByteString -> m ()), MonadIO m) => MethodInfo * BitReaderInitMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderInitMethodInfo BitReader -> signature -> s #
((~) * signature (m Word32), MonadIO m) => MethodInfo * BitReaderGetSizeMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetSizeMethodInfo BitReader -> signature -> s #
((~) * signature (m Word32), MonadIO m) => MethodInfo * BitReaderGetRemainingMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetRemainingMethodInfo BitReader -> signature -> s #
((~) * signature (m Word32), MonadIO m) => MethodInfo * BitReaderGetPosMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetPosMethodInfo BitReader -> signature -> s #
((~) * signature (Word32 -> m (Bool, Word8)), MonadIO m) => MethodInfo * BitReaderGetBitsUint8MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetBitsUint8MethodInfo BitReader -> signature -> s #
((~) * signature (Word32 -> m (Bool, Word64)), MonadIO m) => MethodInfo * BitReaderGetBitsUint64MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetBitsUint64MethodInfo BitReader -> signature -> s #
((~) * signature (Word32 -> m (Bool, Word32)), MonadIO m) => MethodInfo * BitReaderGetBitsUint32MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetBitsUint32MethodInfo BitReader -> signature -> s #
((~) * signature (Word32 -> m (Bool, Word16)), MonadIO m) => MethodInfo * BitReaderGetBitsUint16MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetBitsUint16MethodInfo BitReader -> signature -> s #
((~) * signature (m ()), MonadIO m) => MethodInfo * BitReaderFreeMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderFreeMethodInfo BitReader -> signature -> s #
type AttributeList BitReader Source #
type AttributeList BitReader

newZeroBitReader :: MonadIO m => m BitReader Source #

Construct a BitReader struct initialized to zero.

noBitReader :: Maybe BitReader Source #

Methods

free

data BitReaderFreeMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * BitReaderFreeMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderFreeMethodInfo BitReader -> signature -> s #

bitReaderFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> m ()

Frees a BitReader instance, which was previously allocated by gst_bit_reader_new().

getBitsUint16

data BitReaderGetBitsUint16MethodInfo Source #

Instances

((~) * signature (Word32 -> m (Bool, Word16)), MonadIO m) => MethodInfo * BitReaderGetBitsUint16MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetBitsUint16MethodInfo BitReader -> signature -> s #

bitReaderGetBitsUint16 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> Word32	`nbits`: number of bits to read
-> m (Bool, Word16)	Returns: `True` if successful, `False` otherwise.

Read nbits bits into val and update the current position.

getBitsUint32

data BitReaderGetBitsUint32MethodInfo Source #

Instances

((~) * signature (Word32 -> m (Bool, Word32)), MonadIO m) => MethodInfo * BitReaderGetBitsUint32MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetBitsUint32MethodInfo BitReader -> signature -> s #

bitReaderGetBitsUint32 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> Word32	`nbits`: number of bits to read
-> m (Bool, Word32)	Returns: `True` if successful, `False` otherwise.

Read nbits bits into val and update the current position.

getBitsUint64

data BitReaderGetBitsUint64MethodInfo Source #

Instances

((~) * signature (Word32 -> m (Bool, Word64)), MonadIO m) => MethodInfo * BitReaderGetBitsUint64MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetBitsUint64MethodInfo BitReader -> signature -> s #

bitReaderGetBitsUint64 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> Word32	`nbits`: number of bits to read
-> m (Bool, Word64)	Returns: `True` if successful, `False` otherwise.

Read nbits bits into val and update the current position.

getBitsUint8

data BitReaderGetBitsUint8MethodInfo Source #

Instances

((~) * signature (Word32 -> m (Bool, Word8)), MonadIO m) => MethodInfo * BitReaderGetBitsUint8MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetBitsUint8MethodInfo BitReader -> signature -> s #

bitReaderGetBitsUint8 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> Word32	`nbits`: number of bits to read
-> m (Bool, Word8)	Returns: `True` if successful, `False` otherwise.

Read nbits bits into val and update the current position.

getPos

data BitReaderGetPosMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * BitReaderGetPosMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetPosMethodInfo BitReader -> signature -> s #

bitReaderGetPos Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> m Word32	Returns: The current position of `reader` in bits.

Returns the current position of a BitReader instance in bits.

getRemaining

data BitReaderGetRemainingMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * BitReaderGetRemainingMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetRemainingMethodInfo BitReader -> signature -> s #

bitReaderGetRemaining Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> m Word32	Returns: The remaining number of bits of `reader` instance.

Returns the remaining number of bits of a BitReader instance.

getSize

data BitReaderGetSizeMethodInfo Source #

Instances

((~) * signature (m Word32), MonadIO m) => MethodInfo * BitReaderGetSizeMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderGetSizeMethodInfo BitReader -> signature -> s #

bitReaderGetSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> m Word32	Returns: The total number of bits of `reader` instance.

Returns the total number of bits of a BitReader instance.

init

data BitReaderInitMethodInfo Source #

Instances

((~) * signature (ByteString -> m ()), MonadIO m) => MethodInfo * BitReaderInitMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderInitMethodInfo BitReader -> signature -> s #

bitReaderInit Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> ByteString	`data`: data from which the bit reader should read
-> m ()

Initializes a BitReader instance to read from data. This function can be called on already initialized instances.

peekBitsUint16

data BitReaderPeekBitsUint16MethodInfo Source #

Instances

((~) * signature (Word32 -> m (Bool, Word16)), MonadIO m) => MethodInfo * BitReaderPeekBitsUint16MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderPeekBitsUint16MethodInfo BitReader -> signature -> s #

bitReaderPeekBitsUint16 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> Word32	`nbits`: number of bits to read
-> m (Bool, Word16)	Returns: `True` if successful, `False` otherwise.

Read nbits bits into val but keep the current position.

peekBitsUint32

data BitReaderPeekBitsUint32MethodInfo Source #

Instances

((~) * signature (Word32 -> m (Bool, Word32)), MonadIO m) => MethodInfo * BitReaderPeekBitsUint32MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderPeekBitsUint32MethodInfo BitReader -> signature -> s #

bitReaderPeekBitsUint32 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> Word32	`nbits`: number of bits to read
-> m (Bool, Word32)	Returns: `True` if successful, `False` otherwise.

Read nbits bits into val but keep the current position.

peekBitsUint64

data BitReaderPeekBitsUint64MethodInfo Source #

Instances

((~) * signature (Word32 -> m (Bool, Word64)), MonadIO m) => MethodInfo * BitReaderPeekBitsUint64MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderPeekBitsUint64MethodInfo BitReader -> signature -> s #

bitReaderPeekBitsUint64 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> Word32	`nbits`: number of bits to read
-> m (Bool, Word64)	Returns: `True` if successful, `False` otherwise.

Read nbits bits into val but keep the current position.

peekBitsUint8

data BitReaderPeekBitsUint8MethodInfo Source #

Instances

((~) * signature (Word32 -> m (Bool, Word8)), MonadIO m) => MethodInfo * BitReaderPeekBitsUint8MethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderPeekBitsUint8MethodInfo BitReader -> signature -> s #

bitReaderPeekBitsUint8 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> Word32	`nbits`: number of bits to read
-> m (Bool, Word8)	Returns: `True` if successful, `False` otherwise.

Read nbits bits into val but keep the current position.

setPos

data BitReaderSetPosMethodInfo Source #

Instances

((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * BitReaderSetPosMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderSetPosMethodInfo BitReader -> signature -> s #

bitReaderSetPos Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> Word32	`pos`: The new position in bits
-> m Bool	Returns: `True` if the position could be set successfully, `False` otherwise.

Sets the new position of a BitReader instance to pos in bits.

skip

data BitReaderSkipMethodInfo Source #

Instances

((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * BitReaderSkipMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderSkipMethodInfo BitReader -> signature -> s #

bitReaderSkip Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> Word32	`nbits`: the number of bits to skip
-> m Bool	Returns: `True` if `nbits` bits could be skipped, `False` otherwise.

Skips nbits bits of the BitReader instance.

skipToByte

data BitReaderSkipToByteMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * BitReaderSkipToByteMethodInfo BitReader signature Source #
Methods overloadedMethod :: MethodProxy BitReaderSkipToByteMethodInfo BitReader -> signature -> s #

bitReaderSkipToByte Source #

Arguments

:: (HasCallStack, MonadIO m)
=> BitReader	`reader`: a `BitReader` instance
-> m Bool	Returns: `True` if successful, `False` otherwise.

Skips until the next byte.

Properties

bit

bitReader_bit :: AttrLabelProxy "bit" Source #

getBitReaderBit :: MonadIO m => BitReader -> m Word32 Source #

setBitReaderBit :: MonadIO m => BitReader -> Word32 -> m () Source #

byte

bitReader_byte :: AttrLabelProxy "byte" Source #

getBitReaderByte :: MonadIO m => BitReader -> m Word32 Source #

setBitReaderByte :: MonadIO m => BitReader -> Word32 -> m () Source #

size

bitReader_size :: AttrLabelProxy "size" Source #

getBitReaderSize :: MonadIO m => BitReader -> m Word32 Source #

setBitReaderSize :: MonadIO m => BitReader -> Word32 -> m () Source #