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.Objects.ZlibDecompressor
Description
GZlibDecompressor
is an implementation of Converter
that
decompresses data compressed with zlib.
Synopsis
- newtype ZlibDecompressor = ZlibDecompressor (ManagedPtr ZlibDecompressor)
- class (GObject o, IsDescendantOf ZlibDecompressor o) => IsZlibDecompressor o
- toZlibDecompressor :: (MonadIO m, IsZlibDecompressor o) => o -> m ZlibDecompressor
- type family ResolveZlibDecompressorMethod (t :: Symbol) o where ...
- data ZlibDecompressorGetFileInfoMethodInfo
- zlibDecompressorGetFileInfo :: (HasCallStack, MonadIO m, IsZlibDecompressor a) => a -> m (Maybe FileInfo)
- zlibDecompressorNew :: (HasCallStack, MonadIO m) => ZlibCompressorFormat -> m ZlibDecompressor
- data ZlibDecompressorFileInfoPropertyInfo
- getZlibDecompressorFileInfo :: (MonadIO m, IsZlibDecompressor o) => o -> m (Maybe FileInfo)
- zlibDecompressorFileInfo :: AttrLabelProxy "fileInfo"
- data ZlibDecompressorFormatPropertyInfo
- constructZlibDecompressorFormat :: (IsZlibDecompressor o, MonadIO m) => ZlibCompressorFormat -> m (GValueConstruct o)
- getZlibDecompressorFormat :: (MonadIO m, IsZlibDecompressor o) => o -> m ZlibCompressorFormat
- zlibDecompressorFormat :: AttrLabelProxy "format"
Exported types
newtype ZlibDecompressor Source #
Memory-managed wrapper type.
Constructors
ZlibDecompressor (ManagedPtr ZlibDecompressor) |
Instances
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 # | |
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
.
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, convert, convertBytes, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, reset, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getFileInfo, getProperty, getQdata.
Setters
type family ResolveZlibDecompressorMethod (t :: Symbol) o where ... Source #
Equations
getFileInfo
data ZlibDecompressorGetFileInfoMethodInfo Source #
Instances
(signature ~ m (Maybe FileInfo), MonadIO m, IsZlibDecompressor a) => OverloadedMethod ZlibDecompressorGetFileInfoMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.ZlibDecompressor Methods overloadedMethod :: a -> signature # | |
OverloadedMethodInfo ZlibDecompressorGetFileInfoMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.ZlibDecompressor Methods |
zlibDecompressorGetFileInfo Source #
Arguments
:: (HasCallStack, MonadIO m, IsZlibDecompressor a) | |
=> a |
|
-> m (Maybe FileInfo) |
Retrieves the FileInfo
constructed from the GZIP header data
of compressed data processed by compressor
, or Nothing
if decompressor
's
ZlibDecompressor: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
Arguments
:: (HasCallStack, MonadIO m) | |
=> ZlibCompressorFormat |
|
-> m ZlibDecompressor | Returns: a new |
Creates a new ZlibDecompressor
.
Since: 2.24
Properties
fileInfo
A FileInfo
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
ZlibDecompressor:format property is not ZlibCompressorFormatGzip
.
Since: 2.26
data ZlibDecompressorFileInfoPropertyInfo Source #
Instances
getZlibDecompressorFileInfo :: (MonadIO m, IsZlibDecompressor o) => o -> m (Maybe FileInfo) Source #
Get the value of the “file-info
” property.
When overloading is enabled, this is equivalent to
get
zlibDecompressor #fileInfo
zlibDecompressorFileInfo :: AttrLabelProxy "fileInfo" Source #
format
The format of the compressed data.
Since: 2.24
data ZlibDecompressorFormatPropertyInfo Source #
Instances
AttrInfo ZlibDecompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibDecompressor Associated Types
Methods attrGet :: AttrBaseTypeConstraint ZlibDecompressorFormatPropertyInfo o => o -> IO (AttrGetType ZlibDecompressorFormatPropertyInfo) # attrSet :: (AttrBaseTypeConstraint ZlibDecompressorFormatPropertyInfo o, AttrSetTypeConstraint ZlibDecompressorFormatPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint ZlibDecompressorFormatPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint ZlibDecompressorFormatPropertyInfo o, AttrSetTypeConstraint ZlibDecompressorFormatPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint ZlibDecompressorFormatPropertyInfo o, AttrTransferTypeConstraint ZlibDecompressorFormatPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType ZlibDecompressorFormatPropertyInfo) # | |||||||||||||||||||||||||||||||||
type AttrAllowedOps ZlibDecompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibDecompressor | |||||||||||||||||||||||||||||||||
type AttrBaseTypeConstraint ZlibDecompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrGetType ZlibDecompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrLabel ZlibDecompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibDecompressor | |||||||||||||||||||||||||||||||||
type AttrOrigin ZlibDecompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrSetTypeConstraint ZlibDecompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferType ZlibDecompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
type AttrTransferTypeConstraint ZlibDecompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
constructZlibDecompressorFormat :: (IsZlibDecompressor o, MonadIO m) => ZlibCompressorFormat -> m (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
zlibDecompressorFormat :: AttrLabelProxy "format" Source #