gi-gio-2.0.35: Gio bindings

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

GI.Gio.Structs.SeekableIface

Contents

- Exported types
- Methods
- Properties
  - canSeek
  - canTruncate
  - gIface
  - seek
  - tell
  - truncateFn

Description

Provides an interface for implementing seekable functionality on I/O Streams.

Synopsis

- newtype SeekableIface = SeekableIface (ManagedPtr SeekableIface)
- newZeroSeekableIface :: MonadIO m => m SeekableIface
- clearSeekableIfaceCanSeek :: MonadIO m => SeekableIface -> m ()
- getSeekableIfaceCanSeek :: MonadIO m => SeekableIface -> m (Maybe SeekableIfaceCanSeekFieldCallback)
- setSeekableIfaceCanSeek :: MonadIO m => SeekableIface -> FunPtr C_SeekableIfaceCanSeekFieldCallback -> m ()
- clearSeekableIfaceCanTruncate :: MonadIO m => SeekableIface -> m ()
- getSeekableIfaceCanTruncate :: MonadIO m => SeekableIface -> m (Maybe SeekableIfaceCanTruncateFieldCallback)
- setSeekableIfaceCanTruncate :: MonadIO m => SeekableIface -> FunPtr C_SeekableIfaceCanTruncateFieldCallback -> m ()
- getSeekableIfaceGIface :: MonadIO m => SeekableIface -> m TypeInterface
- clearSeekableIfaceSeek :: MonadIO m => SeekableIface -> m ()
- getSeekableIfaceSeek :: MonadIO m => SeekableIface -> m (Maybe SeekableIfaceSeekFieldCallback)
- setSeekableIfaceSeek :: MonadIO m => SeekableIface -> FunPtr C_SeekableIfaceSeekFieldCallback -> m ()
- clearSeekableIfaceTell :: MonadIO m => SeekableIface -> m ()
- getSeekableIfaceTell :: MonadIO m => SeekableIface -> m (Maybe SeekableIfaceTellFieldCallback)
- setSeekableIfaceTell :: MonadIO m => SeekableIface -> FunPtr C_SeekableIfaceTellFieldCallback -> m ()
- clearSeekableIfaceTruncateFn :: MonadIO m => SeekableIface -> m ()
- getSeekableIfaceTruncateFn :: MonadIO m => SeekableIface -> m (Maybe SeekableIfaceTruncateFnFieldCallback)
- setSeekableIfaceTruncateFn :: MonadIO m => SeekableIface -> FunPtr C_SeekableIfaceTruncateFnFieldCallback -> m ()

# Exported types

newtype SeekableIface Source #

Memory-managed wrapper type.

Constructors

SeekableIface (ManagedPtr SeekableIface) |

#### Instances

Instances details

Eq SeekableIface Source # |
Instance details Defined in GI.Gio.Structs.SeekableIface Methods (==) :: SeekableIface -> SeekableIface -> Bool Source # (/=) :: SeekableIface -> SeekableIface -> Bool Source #
BoxedPtr SeekableIface Source # |
Instance details Defined in GI.Gio.Structs.SeekableIface Methods boxedPtrCopy :: SeekableIface -> IO SeekableIface Source # boxedPtrFree :: SeekableIface -> IO () Source #
CallocPtr SeekableIface Source # |
Instance details Defined in GI.Gio.Structs.SeekableIface Methods boxedPtrCalloc :: IO (Ptr SeekableIface) Source #
ManagedPtrNewtype SeekableIface Source # |
Instance details Defined in GI.Gio.Structs.SeekableIface Methods toManagedPtr :: SeekableIface -> ManagedPtr SeekableIface Source #
tag ~ 'AttrSet => Constructible SeekableIface tag Source # |
Instance details Defined in GI.Gio.Structs.SeekableIface Methods new :: MonadIO m => (ManagedPtr SeekableIface -> SeekableIface) -> [AttrOp SeekableIface tag] -> m SeekableIface Source #

newZeroSeekableIface :: MonadIO m => m SeekableIface Source #

Construct a `SeekableIface` struct initialized to zero.

# Methods

# Properties

## canSeek

Checks if seeking is supported by the stream.

clearSeekableIfaceCanSeek :: MonadIO m => SeekableIface -> m () Source #

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

    clear #canSeek

getSeekableIfaceCanSeek :: MonadIO m => SeekableIface -> m (Maybe SeekableIfaceCanSeekFieldCallback) Source #

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

    get seekableIface #canSeek

setSeekableIfaceCanSeek :: MonadIO m => SeekableIface -> FunPtr C_SeekableIfaceCanSeekFieldCallback -> m () Source #

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

    set seekableIface [ #canSeek := value ]

## canTruncate

Checks if truncation is supported by the stream.

clearSeekableIfaceCanTruncate :: MonadIO m => SeekableIface -> m () Source #

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

    clear #canTruncate

getSeekableIfaceCanTruncate :: MonadIO m => SeekableIface -> m (Maybe SeekableIfaceCanTruncateFieldCallback) Source #

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

    get seekableIface #canTruncate

setSeekableIfaceCanTruncate :: MonadIO m => SeekableIface -> FunPtr C_SeekableIfaceCanTruncateFieldCallback -> m () Source #

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

    set seekableIface [ #canTruncate := value ]

## gIface

The parent interface.

getSeekableIfaceGIface :: MonadIO m => SeekableIface -> m TypeInterface Source #

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

    get seekableIface #gIface

## seek

Seeks to a location within a stream.

clearSeekableIfaceSeek :: MonadIO m => SeekableIface -> m () Source #

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

    clear #seek

getSeekableIfaceSeek :: MonadIO m => SeekableIface -> m (Maybe SeekableIfaceSeekFieldCallback) Source #

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

    get seekableIface #seek

setSeekableIfaceSeek :: MonadIO m => SeekableIface -> FunPtr C_SeekableIfaceSeekFieldCallback -> m () Source #

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

    set seekableIface [ #seek := value ]

## tell

Tells the current location within a stream.

clearSeekableIfaceTell :: MonadIO m => SeekableIface -> m () Source #

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

    clear #tell

getSeekableIfaceTell :: MonadIO m => SeekableIface -> m (Maybe SeekableIfaceTellFieldCallback) Source #

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

    get seekableIface #tell

setSeekableIfaceTell :: MonadIO m => SeekableIface -> FunPtr C_SeekableIfaceTellFieldCallback -> m () Source #

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

    set seekableIface [ #tell := value ]

## truncateFn

Truncates a stream.

clearSeekableIfaceTruncateFn :: MonadIO m => SeekableIface -> m () Source #

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

    clear #truncateFn

getSeekableIfaceTruncateFn :: MonadIO m => SeekableIface -> m (Maybe SeekableIfaceTruncateFnFieldCallback) Source #

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

    get seekableIface #truncateFn

setSeekableIfaceTruncateFn :: MonadIO m => SeekableIface -> FunPtr C_SeekableIfaceTruncateFnFieldCallback -> m () Source #

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

    set seekableIface [ #truncateFn := value ]