gi-gio-2.0.25: Gio bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Objects.ZlibDecompressor

Contents

Description

Zlib decompression

Synopsis

Exported types

newtype ZlibDecompressor Source #

Memory-managed wrapper type.

Constructors

ZlibDecompressor (ManagedPtr ZlibDecompressor) 
Instances
Eq ZlibDecompressor Source # 
Instance details

Defined in GI.Gio.Objects.ZlibDecompressor

GObject ZlibDecompressor Source # 
Instance details

Defined in GI.Gio.Objects.ZlibDecompressor

Methods

gobjectType :: IO GType

IsGValue ZlibDecompressor Source #

Convert ZlibDecompressor to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Gio.Objects.ZlibDecompressor

Methods

toGValue :: ZlibDecompressor -> IO GValue

fromGValue :: GValue -> IO ZlibDecompressor

HasParentTypes ZlibDecompressor Source # 
Instance details

Defined in GI.Gio.Objects.ZlibDecompressor

type ParentTypes ZlibDecompressor Source # 
Instance details

Defined in GI.Gio.Objects.ZlibDecompressor

type ParentTypes ZlibDecompressor = Object ': (Converter ': ([] :: [Type]))

class (GObject o, IsDescendantOf ZlibDecompressor o) => IsZlibDecompressor o Source #

Type class for types which can be safely cast to ZlibDecompressor, for instance with toZlibDecompressor.

Instances
(GObject o, IsDescendantOf ZlibDecompressor o) => IsZlibDecompressor o Source # 
Instance details

Defined in GI.Gio.Objects.ZlibDecompressor

toZlibDecompressor :: (MonadIO m, IsZlibDecompressor o) => o -> m ZlibDecompressor Source #

Cast to ZlibDecompressor, for types for which this is known to be safe. For general casts, use castTo.

noZlibDecompressor :: Maybe ZlibDecompressor Source #

A convenience alias for Nothing :: Maybe ZlibDecompressor.

Methods

Overloaded methods

getFileInfo

zlibDecompressorGetFileInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsZlibDecompressor a) 
=> a

decompressor: a tZlibDecompressor

-> m FileInfo

Returns: a tFileInfo, or Nothing

Retrieves the tFileInfo constructed from the GZIP header data of compressed data processed by compressor, or Nothing if decompressor's tZlibDecompressor:format property is not ZlibCompressorFormatGzip, or the header data was not fully processed yet, or it not present in the data stream at all.

Since: 2.26

new

zlibDecompressorNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ZlibCompressorFormat

format: The format to use for the compressed data

-> m ZlibDecompressor

Returns: a new tZlibDecompressor

Creates a new tZlibDecompressor.

Since: 2.24

Properties

fileInfo

A tFileInfo containing the information found in the GZIP header of the data stream processed, or Nothing if the header was not yet fully processed, is not present at all, or the compressor's tZlibDecompressor:format property is not ZlibCompressorFormatGzip.

Since: 2.26

getZlibDecompressorFileInfo :: (MonadIO m, IsZlibDecompressor o) => o -> m FileInfo Source #

Get the value of the “file-info” property. When overloading is enabled, this is equivalent to

get zlibDecompressor #fileInfo

format

No description available in the introspection data.

constructZlibDecompressorFormat :: IsZlibDecompressor o => ZlibCompressorFormat -> IO (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “format” property. This is rarely needed directly, but it is used by new.

getZlibDecompressorFormat :: (MonadIO m, IsZlibDecompressor o) => o -> m ZlibCompressorFormat Source #

Get the value of the “format” property. When overloading is enabled, this is equivalent to

get zlibDecompressor #format