gi-gstbase-1.0.2: GStreamerBase bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.GstBase.Structs.ByteWriter

Contents

Description

#GstByteWriter provides a byte writer and reader that can write/read different integer and floating point types to/from a memory buffer. It provides functions for writingreading signedunsigned, little/big endian integers of 8, 16, 24, 32 and 64 bits and functions for reading little/big endian floating points numbers of 32 and 64 bits. It also provides functions to write/read NUL-terminated strings in various character encodings.

Synopsis

Exported types

newtype ByteWriter Source

Constructors

ByteWriter (ForeignPtr ByteWriter) 

Instances

WrappedPtr ByteWriter Source 
(~) AttrOpTag tag AttrSet => Constructible ByteWriter tag Source 
((~) * signature (m (Ptr Word8)), MonadIO m) => MethodInfo * ByteWriterResetAndGetDataMethodInfo ByteWriter signature Source 
((~) * signature (m Buffer), MonadIO m) => MethodInfo * ByteWriterResetAndGetBufferMethodInfo ByteWriter signature Source 
((~) * signature (m ()), MonadIO m) => MethodInfo * ByteWriterResetMethodInfo ByteWriter signature Source 
((~) * signature (Word8 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint8MethodInfo ByteWriter signature Source 
((~) * signature (Word64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint64LeMethodInfo ByteWriter signature Source 
((~) * signature (Word64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint64BeMethodInfo ByteWriter signature Source 
((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint32LeMethodInfo ByteWriter signature Source 
((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint32BeMethodInfo ByteWriter signature Source 
((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint24LeMethodInfo ByteWriter signature Source 
((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint24BeMethodInfo ByteWriter signature Source 
((~) * signature (Word16 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint16LeMethodInfo ByteWriter signature Source 
((~) * signature (Word16 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint16BeMethodInfo ByteWriter signature Source 
((~) * signature ([Text] -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutStringUtf8MethodInfo ByteWriter signature Source 
((~) * signature ([Word32] -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutStringUtf32MethodInfo ByteWriter signature Source 
((~) * signature ([Word16] -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutStringUtf16MethodInfo ByteWriter signature Source 
((~) * signature (Int8 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt8MethodInfo ByteWriter signature Source 
((~) * signature (Int64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt64LeMethodInfo ByteWriter signature Source 
((~) * signature (Int64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt64BeMethodInfo ByteWriter signature Source 
((~) * signature (Int32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt32LeMethodInfo ByteWriter signature Source 
((~) * signature (Int32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt32BeMethodInfo ByteWriter signature Source 
((~) * signature (Int32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt24LeMethodInfo ByteWriter signature Source 
((~) * signature (Int32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt24BeMethodInfo ByteWriter signature Source 
((~) * signature (Int16 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt16LeMethodInfo ByteWriter signature Source 
((~) * signature (Int16 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt16BeMethodInfo ByteWriter signature Source 
((~) * signature (Double -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutFloat64LeMethodInfo ByteWriter signature Source 
((~) * signature (Double -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutFloat64BeMethodInfo ByteWriter signature Source 
((~) * signature (Float -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutFloat32LeMethodInfo ByteWriter signature Source 
((~) * signature (Float -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutFloat32BeMethodInfo ByteWriter signature Source 
((~) * signature (ByteString -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutDataMethodInfo ByteWriter signature Source 
((~) * signature (Buffer -> Word64 -> Int64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutBufferMethodInfo ByteWriter signature Source 
((~) * signature (Word32 -> Bool -> m ()), MonadIO m) => MethodInfo * ByteWriterInitWithSizeMethodInfo ByteWriter signature Source 
((~) * signature (ByteString -> Bool -> m ()), MonadIO m) => MethodInfo * ByteWriterInitWithDataMethodInfo ByteWriter signature Source 
((~) * signature (m ()), MonadIO m) => MethodInfo * ByteWriterInitMethodInfo ByteWriter signature Source 
((~) * signature (m Word32), MonadIO m) => MethodInfo * ByteWriterGetRemainingMethodInfo ByteWriter signature Source 
((~) * signature (m Word8), MonadIO m) => MethodInfo * ByteWriterFreeAndGetDataMethodInfo ByteWriter signature Source 
((~) * signature (m Buffer), MonadIO m) => MethodInfo * ByteWriterFreeAndGetBufferMethodInfo ByteWriter signature Source 
((~) * signature (m ()), MonadIO m) => MethodInfo * ByteWriterFreeMethodInfo ByteWriter signature Source 
((~) * signature (Word8 -> Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterFillMethodInfo ByteWriter signature Source 
((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterEnsureFreeSpaceMethodInfo ByteWriter signature Source 
((~) * info (ResolveByteWriterMethod t ByteWriter), MethodInfo * info ByteWriter p) => IsLabelProxy t (ByteWriter -> p) Source 
type AttributeList ByteWriter Source 

newZeroByteWriter :: MonadIO m => m ByteWriter Source

Construct a ByteWriter struct initialized to zero.

noByteWriter :: Maybe ByteWriter Source

Methods

byteWriterEnsureFreeSpace

data ByteWriterEnsureFreeSpaceMethodInfo Source

Instances

byteWriterEnsureFreeSpace :: MonadIO m => ByteWriter -> Word32 -> m Bool Source

byteWriterFill

data ByteWriterFillMethodInfo Source

Instances

((~) * signature (Word8 -> Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterFillMethodInfo ByteWriter signature Source 

byteWriterFill :: MonadIO m => ByteWriter -> Word8 -> Word32 -> m Bool Source

byteWriterFree

data ByteWriterFreeMethodInfo Source

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * ByteWriterFreeMethodInfo ByteWriter signature Source 

byteWriterFree :: MonadIO m => ByteWriter -> m () Source

byteWriterFreeAndGetBuffer

data ByteWriterFreeAndGetBufferMethodInfo Source

Instances

byteWriterFreeAndGetBuffer :: MonadIO m => ByteWriter -> m Buffer Source

byteWriterFreeAndGetData

data ByteWriterFreeAndGetDataMethodInfo Source

Instances

byteWriterFreeAndGetData :: MonadIO m => ByteWriter -> m Word8 Source

byteWriterGetRemaining

data ByteWriterGetRemainingMethodInfo Source

Instances

byteWriterGetRemaining :: MonadIO m => ByteWriter -> m Word32 Source

byteWriterInit

data ByteWriterInitMethodInfo Source

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * ByteWriterInitMethodInfo ByteWriter signature Source 

byteWriterInit :: MonadIO m => ByteWriter -> m () Source

byteWriterInitWithData

data ByteWriterInitWithDataMethodInfo Source

Instances

((~) * signature (ByteString -> Bool -> m ()), MonadIO m) => MethodInfo * ByteWriterInitWithDataMethodInfo ByteWriter signature Source 

byteWriterInitWithData :: MonadIO m => ByteWriter -> ByteString -> Bool -> m () Source

byteWriterInitWithSize

data ByteWriterInitWithSizeMethodInfo Source

Instances

((~) * signature (Word32 -> Bool -> m ()), MonadIO m) => MethodInfo * ByteWriterInitWithSizeMethodInfo ByteWriter signature Source 

byteWriterInitWithSize :: MonadIO m => ByteWriter -> Word32 -> Bool -> m () Source

byteWriterPutBuffer

data ByteWriterPutBufferMethodInfo Source

Instances

((~) * signature (Buffer -> Word64 -> Int64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutBufferMethodInfo ByteWriter signature Source 

byteWriterPutBuffer :: MonadIO m => ByteWriter -> Buffer -> Word64 -> Int64 -> m Bool Source

byteWriterPutData

data ByteWriterPutDataMethodInfo Source

Instances

((~) * signature (ByteString -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutDataMethodInfo ByteWriter signature Source 

byteWriterPutData :: MonadIO m => ByteWriter -> ByteString -> m Bool Source

byteWriterPutFloat32Be

data ByteWriterPutFloat32BeMethodInfo Source

Instances

((~) * signature (Float -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutFloat32BeMethodInfo ByteWriter signature Source 

byteWriterPutFloat32Be :: MonadIO m => ByteWriter -> Float -> m Bool Source

byteWriterPutFloat32Le

data ByteWriterPutFloat32LeMethodInfo Source

Instances

((~) * signature (Float -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutFloat32LeMethodInfo ByteWriter signature Source 

byteWriterPutFloat32Le :: MonadIO m => ByteWriter -> Float -> m Bool Source

byteWriterPutFloat64Be

data ByteWriterPutFloat64BeMethodInfo Source

Instances

((~) * signature (Double -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutFloat64BeMethodInfo ByteWriter signature Source 

byteWriterPutFloat64Be :: MonadIO m => ByteWriter -> Double -> m Bool Source

byteWriterPutFloat64Le

data ByteWriterPutFloat64LeMethodInfo Source

Instances

((~) * signature (Double -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutFloat64LeMethodInfo ByteWriter signature Source 

byteWriterPutFloat64Le :: MonadIO m => ByteWriter -> Double -> m Bool Source

byteWriterPutInt16Be

data ByteWriterPutInt16BeMethodInfo Source

Instances

((~) * signature (Int16 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt16BeMethodInfo ByteWriter signature Source 

byteWriterPutInt16Be :: MonadIO m => ByteWriter -> Int16 -> m Bool Source

byteWriterPutInt16Le

data ByteWriterPutInt16LeMethodInfo Source

Instances

((~) * signature (Int16 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt16LeMethodInfo ByteWriter signature Source 

byteWriterPutInt16Le :: MonadIO m => ByteWriter -> Int16 -> m Bool Source

byteWriterPutInt24Be

data ByteWriterPutInt24BeMethodInfo Source

Instances

((~) * signature (Int32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt24BeMethodInfo ByteWriter signature Source 

byteWriterPutInt24Be :: MonadIO m => ByteWriter -> Int32 -> m Bool Source

byteWriterPutInt24Le

data ByteWriterPutInt24LeMethodInfo Source

Instances

((~) * signature (Int32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt24LeMethodInfo ByteWriter signature Source 

byteWriterPutInt24Le :: MonadIO m => ByteWriter -> Int32 -> m Bool Source

byteWriterPutInt32Be

data ByteWriterPutInt32BeMethodInfo Source

Instances

((~) * signature (Int32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt32BeMethodInfo ByteWriter signature Source 

byteWriterPutInt32Be :: MonadIO m => ByteWriter -> Int32 -> m Bool Source

byteWriterPutInt32Le

data ByteWriterPutInt32LeMethodInfo Source

Instances

((~) * signature (Int32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt32LeMethodInfo ByteWriter signature Source 

byteWriterPutInt32Le :: MonadIO m => ByteWriter -> Int32 -> m Bool Source

byteWriterPutInt64Be

data ByteWriterPutInt64BeMethodInfo Source

Instances

((~) * signature (Int64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt64BeMethodInfo ByteWriter signature Source 

byteWriterPutInt64Be :: MonadIO m => ByteWriter -> Int64 -> m Bool Source

byteWriterPutInt64Le

data ByteWriterPutInt64LeMethodInfo Source

Instances

((~) * signature (Int64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt64LeMethodInfo ByteWriter signature Source 

byteWriterPutInt64Le :: MonadIO m => ByteWriter -> Int64 -> m Bool Source

byteWriterPutInt8

data ByteWriterPutInt8MethodInfo Source

Instances

((~) * signature (Int8 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutInt8MethodInfo ByteWriter signature Source 

byteWriterPutInt8 :: MonadIO m => ByteWriter -> Int8 -> m Bool Source

byteWriterPutStringUtf16

data ByteWriterPutStringUtf16MethodInfo Source

Instances

((~) * signature ([Word16] -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutStringUtf16MethodInfo ByteWriter signature Source 

byteWriterPutStringUtf16 :: MonadIO m => ByteWriter -> [Word16] -> m Bool Source

byteWriterPutStringUtf32

data ByteWriterPutStringUtf32MethodInfo Source

Instances

((~) * signature ([Word32] -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutStringUtf32MethodInfo ByteWriter signature Source 

byteWriterPutStringUtf32 :: MonadIO m => ByteWriter -> [Word32] -> m Bool Source

byteWriterPutStringUtf8

data ByteWriterPutStringUtf8MethodInfo Source

Instances

((~) * signature ([Text] -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutStringUtf8MethodInfo ByteWriter signature Source 

byteWriterPutStringUtf8 :: MonadIO m => ByteWriter -> [Text] -> m Bool Source

byteWriterPutUint16Be

data ByteWriterPutUint16BeMethodInfo Source

Instances

((~) * signature (Word16 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint16BeMethodInfo ByteWriter signature Source 

byteWriterPutUint16Be :: MonadIO m => ByteWriter -> Word16 -> m Bool Source

byteWriterPutUint16Le

data ByteWriterPutUint16LeMethodInfo Source

Instances

((~) * signature (Word16 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint16LeMethodInfo ByteWriter signature Source 

byteWriterPutUint16Le :: MonadIO m => ByteWriter -> Word16 -> m Bool Source

byteWriterPutUint24Be

data ByteWriterPutUint24BeMethodInfo Source

Instances

((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint24BeMethodInfo ByteWriter signature Source 

byteWriterPutUint24Be :: MonadIO m => ByteWriter -> Word32 -> m Bool Source

byteWriterPutUint24Le

data ByteWriterPutUint24LeMethodInfo Source

Instances

((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint24LeMethodInfo ByteWriter signature Source 

byteWriterPutUint24Le :: MonadIO m => ByteWriter -> Word32 -> m Bool Source

byteWriterPutUint32Be

data ByteWriterPutUint32BeMethodInfo Source

Instances

((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint32BeMethodInfo ByteWriter signature Source 

byteWriterPutUint32Be :: MonadIO m => ByteWriter -> Word32 -> m Bool Source

byteWriterPutUint32Le

data ByteWriterPutUint32LeMethodInfo Source

Instances

((~) * signature (Word32 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint32LeMethodInfo ByteWriter signature Source 

byteWriterPutUint32Le :: MonadIO m => ByteWriter -> Word32 -> m Bool Source

byteWriterPutUint64Be

data ByteWriterPutUint64BeMethodInfo Source

Instances

((~) * signature (Word64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint64BeMethodInfo ByteWriter signature Source 

byteWriterPutUint64Be :: MonadIO m => ByteWriter -> Word64 -> m Bool Source

byteWriterPutUint64Le

data ByteWriterPutUint64LeMethodInfo Source

Instances

((~) * signature (Word64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint64LeMethodInfo ByteWriter signature Source 

byteWriterPutUint64Le :: MonadIO m => ByteWriter -> Word64 -> m Bool Source

byteWriterPutUint8

data ByteWriterPutUint8MethodInfo Source

Instances

((~) * signature (Word8 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutUint8MethodInfo ByteWriter signature Source 

byteWriterPutUint8 :: MonadIO m => ByteWriter -> Word8 -> m Bool Source

byteWriterReset

data ByteWriterResetMethodInfo Source

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * ByteWriterResetMethodInfo ByteWriter signature Source 

byteWriterReset :: MonadIO m => ByteWriter -> m () Source

byteWriterResetAndGetBuffer

data ByteWriterResetAndGetBufferMethodInfo Source

Instances

byteWriterResetAndGetBuffer :: MonadIO m => ByteWriter -> m Buffer Source

byteWriterResetAndGetData

data ByteWriterResetAndGetDataMethodInfo Source

Instances

byteWriterResetAndGetData :: MonadIO m => ByteWriter -> m (Ptr Word8) Source

Properties

AllocSize

byteWriterAllocSize :: AttrLabelProxy "allocSize" Source

byteWriterReadAllocSize :: MonadIO m => ByteWriter -> m Word32 Source

byteWriterWriteAllocSize :: MonadIO m => ByteWriter -> Word32 -> m () Source

Fixed

byteWriterFixed :: AttrLabelProxy "fixed" Source

byteWriterReadFixed :: MonadIO m => ByteWriter -> m Bool Source

byteWriterWriteFixed :: MonadIO m => ByteWriter -> Bool -> m () Source

Owned

byteWriterOwned :: AttrLabelProxy "owned" Source

byteWriterReadOwned :: MonadIO m => ByteWriter -> m Bool Source

byteWriterWriteOwned :: MonadIO m => ByteWriter -> Bool -> m () Source

Parent

byteWriterClearParent :: MonadIO m => ByteWriter -> m () Source

byteWriterParent :: AttrLabelProxy "parent" Source

byteWriterReadParent :: MonadIO m => ByteWriter -> m (Maybe ByteReader) Source

byteWriterWriteParent :: MonadIO m => ByteWriter -> Ptr ByteReader -> m () Source