| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Objects.ZlibCompressor
Description
Zlib decompression
Synopsis
- newtype ZlibCompressor = ZlibCompressor (ManagedPtr ZlibCompressor)
- class (GObject o, IsDescendantOf ZlibCompressor o) => IsZlibCompressor o
- toZlibCompressor :: (MonadIO m, IsZlibCompressor o) => o -> m ZlibCompressor
- zlibCompressorGetFileInfo :: (HasCallStack, MonadIO m, IsZlibCompressor a) => a -> m FileInfo
- zlibCompressorNew :: (HasCallStack, MonadIO m) => ZlibCompressorFormat -> Int32 -> m ZlibCompressor
- zlibCompressorSetFileInfo :: (HasCallStack, MonadIO m, IsZlibCompressor a, IsFileInfo b) => a -> Maybe b -> m ()
- clearZlibCompressorFileInfo :: (MonadIO m, IsZlibCompressor o) => o -> m ()
- constructZlibCompressorFileInfo :: (IsZlibCompressor o, MonadIO m, IsFileInfo a) => a -> m (GValueConstruct o)
- getZlibCompressorFileInfo :: (MonadIO m, IsZlibCompressor o) => o -> m FileInfo
- setZlibCompressorFileInfo :: (MonadIO m, IsZlibCompressor o, IsFileInfo a) => o -> a -> m ()
- constructZlibCompressorFormat :: (IsZlibCompressor o, MonadIO m) => ZlibCompressorFormat -> m (GValueConstruct o)
- getZlibCompressorFormat :: (MonadIO m, IsZlibCompressor o) => o -> m ZlibCompressorFormat
- constructZlibCompressorLevel :: (IsZlibCompressor o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getZlibCompressorLevel :: (MonadIO m, IsZlibCompressor o) => o -> m Int32
Exported types
newtype ZlibCompressor Source #
Memory-managed wrapper type.
Constructors
| ZlibCompressor (ManagedPtr ZlibCompressor) |
Instances
| Eq ZlibCompressor Source # | |
Defined in GI.Gio.Objects.ZlibCompressor Methods (==) :: ZlibCompressor -> ZlibCompressor -> Bool # (/=) :: ZlibCompressor -> ZlibCompressor -> Bool # | |
| IsGValue ZlibCompressor Source # | Convert |
Defined in GI.Gio.Objects.ZlibCompressor | |
| ManagedPtrNewtype ZlibCompressor Source # | |
Defined in GI.Gio.Objects.ZlibCompressor Methods toManagedPtr :: ZlibCompressor -> ManagedPtr ZlibCompressor # | |
| TypedObject ZlibCompressor Source # | |
Defined in GI.Gio.Objects.ZlibCompressor | |
| GObject ZlibCompressor Source # | |
Defined in GI.Gio.Objects.ZlibCompressor | |
| HasParentTypes ZlibCompressor Source # | |
Defined in GI.Gio.Objects.ZlibCompressor | |
| type ParentTypes ZlibCompressor Source # | |
Defined in GI.Gio.Objects.ZlibCompressor | |
class (GObject o, IsDescendantOf ZlibCompressor o) => IsZlibCompressor o Source #
Type class for types which can be safely cast to ZlibCompressor, for instance with toZlibCompressor.
Instances
| (GObject o, IsDescendantOf ZlibCompressor o) => IsZlibCompressor o Source # | |
Defined in GI.Gio.Objects.ZlibCompressor | |
toZlibCompressor :: (MonadIO m, IsZlibCompressor o) => o -> m ZlibCompressor Source #
Cast to ZlibCompressor, for types for which this is known to be safe. For general casts, use castTo.
Methods
Overloaded methods
getFileInfo
zlibCompressorGetFileInfo Source #
Arguments
| :: (HasCallStack, MonadIO m, IsZlibCompressor a) | |
| => a |
|
| -> m FileInfo |
Returns the ZlibCompressor:file-info property.
Since: 2.26
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ZlibCompressorFormat |
|
| -> Int32 |
|
| -> m ZlibCompressor | Returns: a new |
Creates a new ZlibCompressor.
Since: 2.24
setFileInfo
zlibCompressorSetFileInfo Source #
Arguments
| :: (HasCallStack, MonadIO m, IsZlibCompressor a, IsFileInfo b) | |
| => a |
|
| -> Maybe b |
|
| -> m () |
Sets fileInfo in compressor. If non-Nothing, and compressor's
ZlibCompressor:format property is ZlibCompressorFormatGzip,
it will be used to set the file name and modification time in
the GZIP header of the compressed data.
Note: it is an error to call this function while a compression is in
progress; it may only be called immediately after creation of compressor,
or after resetting it with converterReset.
Since: 2.26
Properties
fileInfo
If set to a non-Nothing FileInfo object, and ZlibCompressor:format is
ZlibCompressorFormatGzip, the compressor will write the file name
and modification time from the file info to the GZIP header.
Since: 2.26
clearZlibCompressorFileInfo :: (MonadIO m, IsZlibCompressor o) => o -> m () Source #
Set the value of the “file-info” property to Nothing.
When overloading is enabled, this is equivalent to
clear #fileInfo
constructZlibCompressorFileInfo :: (IsZlibCompressor o, MonadIO m, IsFileInfo a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “file-info” property. This is rarely needed directly, but it is used by new.
getZlibCompressorFileInfo :: (MonadIO m, IsZlibCompressor o) => o -> m FileInfo Source #
Get the value of the “file-info” property.
When overloading is enabled, this is equivalent to
get zlibCompressor #fileInfo
setZlibCompressorFileInfo :: (MonadIO m, IsZlibCompressor o, IsFileInfo a) => o -> a -> m () Source #
Set the value of the “file-info” property.
When overloading is enabled, this is equivalent to
setzlibCompressor [ #fileInfo:=value ]
format
No description available in the introspection data.
constructZlibCompressorFormat :: (IsZlibCompressor 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.
getZlibCompressorFormat :: (MonadIO m, IsZlibCompressor o) => o -> m ZlibCompressorFormat Source #
Get the value of the “format” property.
When overloading is enabled, this is equivalent to
get zlibCompressor #format
level
No description available in the introspection data.
constructZlibCompressorLevel :: (IsZlibCompressor o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “level” property. This is rarely needed directly, but it is used by new.
getZlibCompressorLevel :: (MonadIO m, IsZlibCompressor o) => o -> m Int32 Source #
Get the value of the “level” property.
When overloading is enabled, this is equivalent to
get zlibCompressor #level