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.ByteWriter

Contents

Exported types
Methods
Properties

Description

ByteWriter 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 writing/reading signed/unsigned, 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 (ManagedPtr ByteWriter)

Instances

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

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

newZeroByteWriter :: MonadIO m => m ByteWriter Source #

Construct a ByteWriter struct initialized to zero.

noByteWriter :: Maybe ByteWriter Source #

Methods

ensureFreeSpace

data ByteWriterEnsureFreeSpaceMethodInfo Source #

Instances

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

byteWriterEnsureFreeSpace Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word32	`size`: Number of bytes that should be available
-> m Bool	Returns: `True` if at least `size` bytes are still available

Checks if enough free space from the current write cursor is available and reallocates if necessary.

fill

data ByteWriterFillMethodInfo Source #

Instances

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

byteWriterFill Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word8	`value`: Value to be written
-> Word32	`size`: Number of bytes to be written
-> m Bool	Returns: `True` if the value could be written

Writes size bytes containing value to writer.

free

data ByteWriterFreeMethodInfo Source #

Instances

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

byteWriterFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> m ()

Frees writer and all memory allocated by it.

freeAndGetBuffer

data ByteWriterFreeAndGetBufferMethodInfo Source #

Instances

((~) * signature (m Buffer), MonadIO m) => MethodInfo * ByteWriterFreeAndGetBufferMethodInfo ByteWriter signature Source #
Methods overloadedMethod :: MethodProxy ByteWriterFreeAndGetBufferMethodInfo ByteWriter -> signature -> s #

byteWriterFreeAndGetBuffer Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> m Buffer	Returns: the current data as buffer. `gst_buffer_unref()` after usage.

Frees writer and all memory allocated by it except the current data, which is returned as Buffer.

Free-function: gst_buffer_unref

freeAndGetData

data ByteWriterFreeAndGetDataMethodInfo Source #

Instances

((~) * signature (m Word8), MonadIO m) => MethodInfo * ByteWriterFreeAndGetDataMethodInfo ByteWriter signature Source #
Methods overloadedMethod :: MethodProxy ByteWriterFreeAndGetDataMethodInfo ByteWriter -> signature -> s #

byteWriterFreeAndGetData Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> m Word8	Returns: the current data. `free` after usage.

Frees writer and all memory allocated by it except the current data, which is returned.

Free-function: g_free

getRemaining

data ByteWriterGetRemainingMethodInfo Source #

Instances

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

byteWriterGetRemaining Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> m Word32	Returns: the remaining size of data that can still be written

Returns the remaining size of data that can still be written. If -1 is returned the remaining size is only limited by system resources.

init

data ByteWriterInitMethodInfo Source #

Instances

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

byteWriterInit Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> m ()

Initializes writer to an empty instance

initWithData

data ByteWriterInitWithDataMethodInfo Source #

Instances

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

byteWriterInitWithData Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> ByteString	`data`: Memory area for writing
-> Bool	`initialized`: If `True` the complete data can be read from the beginning
-> m ()

Initializes writer with the given memory area. If initialized is True it is possible to read size bytes from the ByteWriter from the beginning.

initWithSize

data ByteWriterInitWithSizeMethodInfo Source #

Instances

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

byteWriterInitWithSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word32	`size`: Initial size of data
-> Bool	`fixed`: If `True` the data can't be reallocated
-> m ()

Initializes writer with the given initial data size.

putBuffer

data ByteWriterPutBufferMethodInfo Source #

Instances

((~) * signature (Buffer -> Word64 -> Int64 -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutBufferMethodInfo ByteWriter signature Source #
Methods overloadedMethod :: MethodProxy ByteWriterPutBufferMethodInfo ByteWriter -> signature -> s #

byteWriterPutBuffer Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Buffer	`buffer`: source `Buffer`
-> Word64	`offset`: offset to copy from
-> Int64	`size`: total size to copy. If -1, all data is copied
-> m Bool	Returns: `True` if the data could be written

Writes size bytes of data to writer.

putData

data ByteWriterPutDataMethodInfo Source #

Instances

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

byteWriterPutData Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> ByteString	`data`: Data to write
-> m Bool	Returns: `True` if the value could be written

Writes size bytes of data to writer.

putFloat32Be

data ByteWriterPutFloat32BeMethodInfo Source #

Instances

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

byteWriterPutFloat32Be Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Float	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a big endian 32 bit float to writer.

putFloat32Le

data ByteWriterPutFloat32LeMethodInfo Source #

Instances

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

byteWriterPutFloat32Le Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Float	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a little endian 32 bit float to writer.

putFloat64Be

data ByteWriterPutFloat64BeMethodInfo Source #

Instances

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

byteWriterPutFloat64Be Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Double	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a big endian 64 bit float to writer.

putFloat64Le

data ByteWriterPutFloat64LeMethodInfo Source #

Instances

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

byteWriterPutFloat64Le Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Double	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a little endian 64 bit float to writer.

putInt16Be

data ByteWriterPutInt16BeMethodInfo Source #

Instances

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

byteWriterPutInt16Be Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Int16	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a signed big endian 16 bit integer to writer.

putInt16Le

data ByteWriterPutInt16LeMethodInfo Source #

Instances

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

byteWriterPutInt16Le Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Int16	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a signed little endian 16 bit integer to writer.

putInt24Be

data ByteWriterPutInt24BeMethodInfo Source #

Instances

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

byteWriterPutInt24Be Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Int32	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a signed big endian 24 bit integer to writer.

putInt24Le

data ByteWriterPutInt24LeMethodInfo Source #

Instances

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

byteWriterPutInt24Le Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Int32	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a signed little endian 24 bit integer to writer.

putInt32Be

data ByteWriterPutInt32BeMethodInfo Source #

Instances

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

byteWriterPutInt32Be Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Int32	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a signed big endian 32 bit integer to writer.

putInt32Le

data ByteWriterPutInt32LeMethodInfo Source #

Instances

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

byteWriterPutInt32Le Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Int32	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a signed little endian 32 bit integer to writer.

putInt64Be

data ByteWriterPutInt64BeMethodInfo Source #

Instances

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

byteWriterPutInt64Be Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Int64	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a signed big endian 64 bit integer to writer.

putInt64Le

data ByteWriterPutInt64LeMethodInfo Source #

Instances

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

byteWriterPutInt64Le Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Int64	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a signed little endian 64 bit integer to writer.

putInt8

data ByteWriterPutInt8MethodInfo Source #

Instances

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

byteWriterPutInt8 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Int8	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a signed 8 bit integer to writer.

putStringUtf16

data ByteWriterPutStringUtf16MethodInfo Source #

Instances

((~) * signature ([Word16] -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutStringUtf16MethodInfo ByteWriter signature Source #
Methods overloadedMethod :: MethodProxy ByteWriterPutStringUtf16MethodInfo ByteWriter -> signature -> s #

byteWriterPutStringUtf16 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> [Word16]	`data`: UTF16 string to write
-> m Bool	Returns: `True` if the value could be written

Writes a NUL-terminated UTF16 string to writer (including the terminator).

putStringUtf32

data ByteWriterPutStringUtf32MethodInfo Source #

Instances

((~) * signature ([Word32] -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutStringUtf32MethodInfo ByteWriter signature Source #
Methods overloadedMethod :: MethodProxy ByteWriterPutStringUtf32MethodInfo ByteWriter -> signature -> s #

byteWriterPutStringUtf32 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> [Word32]	`data`: UTF32 string to write
-> m Bool	Returns: `True` if the value could be written

Writes a NUL-terminated UTF32 string to writer (including the terminator).

putStringUtf8

data ByteWriterPutStringUtf8MethodInfo Source #

Instances

((~) * signature ([Text] -> m Bool), MonadIO m) => MethodInfo * ByteWriterPutStringUtf8MethodInfo ByteWriter signature Source #
Methods overloadedMethod :: MethodProxy ByteWriterPutStringUtf8MethodInfo ByteWriter -> signature -> s #

byteWriterPutStringUtf8 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> [Text]	`data`: UTF8 string to write
-> m Bool	Returns: `True` if the value could be written

Writes a NUL-terminated UTF8 string to writer (including the terminator).

putUint16Be

data ByteWriterPutUint16BeMethodInfo Source #

Instances

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

byteWriterPutUint16Be Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word16	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a unsigned big endian 16 bit integer to writer.

putUint16Le

data ByteWriterPutUint16LeMethodInfo Source #

Instances

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

byteWriterPutUint16Le Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word16	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a unsigned little endian 16 bit integer to writer.

putUint24Be

data ByteWriterPutUint24BeMethodInfo Source #

Instances

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

byteWriterPutUint24Be Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word32	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a unsigned big endian 24 bit integer to writer.

putUint24Le

data ByteWriterPutUint24LeMethodInfo Source #

Instances

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

byteWriterPutUint24Le Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word32	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a unsigned little endian 24 bit integer to writer.

putUint32Be

data ByteWriterPutUint32BeMethodInfo Source #

Instances

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

byteWriterPutUint32Be Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word32	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a unsigned big endian 32 bit integer to writer.

putUint32Le

data ByteWriterPutUint32LeMethodInfo Source #

Instances

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

byteWriterPutUint32Le Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word32	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a unsigned little endian 32 bit integer to writer.

putUint64Be

data ByteWriterPutUint64BeMethodInfo Source #

Instances

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

byteWriterPutUint64Be Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word64	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a unsigned big endian 64 bit integer to writer.

putUint64Le

data ByteWriterPutUint64LeMethodInfo Source #

Instances

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

byteWriterPutUint64Le Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word64	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a unsigned little endian 64 bit integer to writer.

putUint8

data ByteWriterPutUint8MethodInfo Source #

Instances

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

byteWriterPutUint8 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> Word8	`val`: Value to write
-> m Bool	Returns: `True` if the value could be written

Writes a unsigned 8 bit integer to writer.

reset

data ByteWriterResetMethodInfo Source #

Instances

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

byteWriterReset Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> m ()

Resets writer and frees the data if it's owned by writer.

resetAndGetBuffer

data ByteWriterResetAndGetBufferMethodInfo Source #

Instances

((~) * signature (m Buffer), MonadIO m) => MethodInfo * ByteWriterResetAndGetBufferMethodInfo ByteWriter signature Source #
Methods overloadedMethod :: MethodProxy ByteWriterResetAndGetBufferMethodInfo ByteWriter -> signature -> s #

byteWriterResetAndGetBuffer Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ByteWriter	`writer`: `ByteWriter` instance
-> m Buffer	Returns: the current data as buffer. `gst_buffer_unref()` after usage.

Resets writer and returns the current data as buffer.

Free-function: gst_buffer_unref

resetAndGetData

data ByteWriterResetAndGetDataMethodInfo Source #

Instances

((~) * signature (m (Ptr Word8)), MonadIO m) => MethodInfo * ByteWriterResetAndGetDataMethodInfo ByteWriter signature Source #
Methods overloadedMethod :: MethodProxy ByteWriterResetAndGetDataMethodInfo ByteWriter -> signature -> s #