Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gio.Structs.InputVector

Contents

Exported types
Methods
Properties
- buffer
- size

Description

Structure used for scatter/gather data input. You generally pass in an array of GInputVectors and the operation will store the read data starting in the first buffer, switching to the next as needed.

Since: 2.22

Synopsis

newtype InputVector = InputVector (ManagedPtr InputVector)
newZeroInputVector :: MonadIO m => m InputVector
type family ResolveInputVectorMethod (t :: Symbol) o where ...
clearInputVectorBuffer :: MonadIO m => InputVector -> m ()
getInputVectorBuffer :: MonadIO m => InputVector -> m (Ptr ())
inputVector_buffer :: AttrLabelProxy "buffer"
setInputVectorBuffer :: MonadIO m => InputVector -> Ptr () -> m ()
getInputVectorSize :: MonadIO m => InputVector -> m CSize
inputVector_size :: AttrLabelProxy "size"
setInputVectorSize :: MonadIO m => InputVector -> CSize -> m ()

Exported types

newtype InputVector Source #

Memory-managed wrapper type.

Constructors

InputVector (ManagedPtr InputVector)

Instances

Instances details

Eq InputVector Source #
Instance details Defined in GI.Gio.Structs.InputVector Methods (==) :: InputVector -> InputVector -> Bool # (/=) :: InputVector -> InputVector -> Bool #
BoxedPtr InputVector Source #
Instance details Defined in GI.Gio.Structs.InputVector Methods boxedPtrCopy :: InputVector -> IO InputVector # boxedPtrFree :: InputVector -> IO () #
CallocPtr InputVector Source #
Instance details Defined in GI.Gio.Structs.InputVector Methods boxedPtrCalloc :: IO (Ptr InputVector) #
ManagedPtrNewtype InputVector Source #
Instance details Defined in GI.Gio.Structs.InputVector Methods toManagedPtr :: InputVector -> ManagedPtr InputVector #
tag ~ 'AttrSet => Constructible InputVector tag Source #
Instance details Defined in GI.Gio.Structs.InputVector Methods new :: MonadIO m => (ManagedPtr InputVector -> InputVector) -> [AttrOp InputVector tag] -> m InputVector #
HasAttributeList InputVector Source #
Instance details Defined in GI.Gio.Structs.InputVector
(info ~ ResolveInputVectorMethod t InputVector, OverloadedMethod info InputVector p, HasField t InputVector p) => HasField (t :: Symbol) InputVector (p :: Type) Source #
Instance details Defined in GI.Gio.Structs.InputVector Methods getField :: InputVector -> p #
(info ~ ResolveInputVectorMethod t InputVector, OverloadedMethodInfo info InputVector) => IsLabel t (MethodProxy info InputVector) Source #
Instance details Defined in GI.Gio.Structs.InputVector Methods fromLabel :: MethodProxy info InputVector #
(info ~ ResolveInputVectorMethod t InputVector, OverloadedMethod info InputVector p) => IsLabel t (InputVector -> p) Source #
Instance details Defined in GI.Gio.Structs.InputVector Methods fromLabel :: InputVector -> p #
type AttributeList InputVector Source #
Instance details Defined in GI.Gio.Structs.InputVector type AttributeList InputVector

newZeroInputVector :: MonadIO m => m InputVector Source #

Construct a InputVector struct initialized to zero.

Methods

type family ResolveInputVectorMethod (t :: Symbol) o where ... Source #

Equations

ResolveInputVectorMethod l o = MethodResolutionFailed l o :: Type

Properties

buffer

Pointer to a buffer where data will be written.

clearInputVectorBuffer :: MonadIO m => InputVector -> m () Source #

Set the value of the “buffer” field to Nothing. When overloading is enabled, this is equivalent to

clear #buffer

getInputVectorBuffer :: MonadIO m => InputVector -> m (Ptr ()) Source #

Get the value of the “buffer” field. When overloading is enabled, this is equivalent to

get inputVector #buffer

inputVector_buffer :: AttrLabelProxy "buffer" Source #

setInputVectorBuffer :: MonadIO m => InputVector -> Ptr () -> m () Source #

Set the value of the “buffer” field. When overloading is enabled, this is equivalent to

set inputVector [ #buffer := value ]

size

the available size in buffer.

getInputVectorSize :: MonadIO m => InputVector -> m CSize Source #

Get the value of the “size” field. When overloading is enabled, this is equivalent to

get inputVector #size

inputVector_size :: AttrLabelProxy "size" Source #

setInputVectorSize :: MonadIO m => InputVector -> CSize -> m () Source #

Set the value of the “size” field. When overloading is enabled, this is equivalent to

set inputVector [ #size := value ]