| 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.ZlibCompressor
Description
GZlibCompressor is an implementation of Converter that
compresses data using zlib.
Synopsis
- newtype ZlibCompressor = ZlibCompressor (ManagedPtr ZlibCompressor)
- class (GObject o, IsDescendantOf ZlibCompressor o) => IsZlibCompressor o
- toZlibCompressor :: (MonadIO m, IsZlibCompressor o) => o -> m ZlibCompressor
- type family ResolveZlibCompressorMethod (t :: Symbol) o where ...
- data ZlibCompressorGetFileInfoMethodInfo
- zlibCompressorGetFileInfo :: (HasCallStack, MonadIO m, IsZlibCompressor a) => a -> m (Maybe FileInfo)
- zlibCompressorNew :: (HasCallStack, MonadIO m) => ZlibCompressorFormat -> Int32 -> m ZlibCompressor
- data ZlibCompressorSetFileInfoMethodInfo
- zlibCompressorSetFileInfo :: (HasCallStack, MonadIO m, IsZlibCompressor a, IsFileInfo b) => a -> Maybe b -> m ()
- data ZlibCompressorFileInfoPropertyInfo
- 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 (Maybe FileInfo)
- setZlibCompressorFileInfo :: (MonadIO m, IsZlibCompressor o, IsFileInfo a) => o -> a -> m ()
- zlibCompressorFileInfo :: AttrLabelProxy "fileInfo"
- data ZlibCompressorFormatPropertyInfo
- constructZlibCompressorFormat :: (IsZlibCompressor o, MonadIO m) => ZlibCompressorFormat -> m (GValueConstruct o)
- getZlibCompressorFormat :: (MonadIO m, IsZlibCompressor o) => o -> m ZlibCompressorFormat
- zlibCompressorFormat :: AttrLabelProxy "format"
- data ZlibCompressorLevelPropertyInfo
- constructZlibCompressorLevel :: (IsZlibCompressor o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getZlibCompressorLevel :: (MonadIO m, IsZlibCompressor o) => o -> m Int32
- zlibCompressorLevel :: AttrLabelProxy "level"
Exported types
newtype ZlibCompressor Source #
Memory-managed wrapper type.
Constructors
| ZlibCompressor (ManagedPtr ZlibCompressor) |
Instances
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
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 ResolveZlibCompressorMethod (t :: Symbol) o where ... Source #
Equations
getFileInfo
data ZlibCompressorGetFileInfoMethodInfo Source #
Instances
| (signature ~ m (Maybe FileInfo), MonadIO m, IsZlibCompressor a) => OverloadedMethod ZlibCompressorGetFileInfoMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.ZlibCompressor Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ZlibCompressorGetFileInfoMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.ZlibCompressor Methods | |
zlibCompressorGetFileInfo Source #
Arguments
| :: (HasCallStack, MonadIO m, IsZlibCompressor a) | |
| => a |
|
| -> m (Maybe FileInfo) |
Returns the ZlibCompressor:fileInfo property.
Since: 2.26
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ZlibCompressorFormat |
|
| -> Int32 |
|
| -> m ZlibCompressor | Returns: a new |
Creates a new ZlibCompressor.
Since: 2.24
setFileInfo
data ZlibCompressorSetFileInfoMethodInfo Source #
Instances
| (signature ~ (Maybe b -> m ()), MonadIO m, IsZlibCompressor a, IsFileInfo b) => OverloadedMethod ZlibCompressorSetFileInfoMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.ZlibCompressor Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo ZlibCompressorSetFileInfoMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.ZlibCompressor Methods | |
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
data ZlibCompressorFileInfoPropertyInfo Source #
Instances
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 (Maybe 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 ]
zlibCompressorFileInfo :: AttrLabelProxy "fileInfo" Source #
format
The format of the compressed data.
Since: 2.24
data ZlibCompressorFormatPropertyInfo Source #
Instances
| AttrInfo ZlibCompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibCompressor Associated Types
Methods attrGet :: AttrBaseTypeConstraint ZlibCompressorFormatPropertyInfo o => o -> IO (AttrGetType ZlibCompressorFormatPropertyInfo) # attrSet :: (AttrBaseTypeConstraint ZlibCompressorFormatPropertyInfo o, AttrSetTypeConstraint ZlibCompressorFormatPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint ZlibCompressorFormatPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint ZlibCompressorFormatPropertyInfo o, AttrSetTypeConstraint ZlibCompressorFormatPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint ZlibCompressorFormatPropertyInfo o, AttrTransferTypeConstraint ZlibCompressorFormatPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType ZlibCompressorFormatPropertyInfo) # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps ZlibCompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibCompressor | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint ZlibCompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType ZlibCompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrLabel ZlibCompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibCompressor | |||||||||||||||||||||||||||||||||
| type AttrOrigin ZlibCompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint ZlibCompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferType ZlibCompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint ZlibCompressorFormatPropertyInfo Source # | |||||||||||||||||||||||||||||||||
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
zlibCompressorFormat :: AttrLabelProxy "format" Source #
level
The level of compression from 0 (no compression) to 9 (most
compression). -1 for the default level.
Since: 2.24
data ZlibCompressorLevelPropertyInfo Source #
Instances
| AttrInfo ZlibCompressorLevelPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibCompressor Associated Types
Methods attrGet :: AttrBaseTypeConstraint ZlibCompressorLevelPropertyInfo o => o -> IO (AttrGetType ZlibCompressorLevelPropertyInfo) # attrSet :: (AttrBaseTypeConstraint ZlibCompressorLevelPropertyInfo o, AttrSetTypeConstraint ZlibCompressorLevelPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint ZlibCompressorLevelPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint ZlibCompressorLevelPropertyInfo o, AttrSetTypeConstraint ZlibCompressorLevelPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint ZlibCompressorLevelPropertyInfo o, AttrTransferTypeConstraint ZlibCompressorLevelPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType ZlibCompressorLevelPropertyInfo) # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps ZlibCompressorLevelPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibCompressor | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint ZlibCompressorLevelPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType ZlibCompressorLevelPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibCompressor | |||||||||||||||||||||||||||||||||
| type AttrLabel ZlibCompressorLevelPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibCompressor | |||||||||||||||||||||||||||||||||
| type AttrOrigin ZlibCompressorLevelPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibCompressor | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint ZlibCompressorLevelPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibCompressor | |||||||||||||||||||||||||||||||||
| type AttrTransferType ZlibCompressorLevelPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.ZlibCompressor | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint ZlibCompressorLevelPropertyInfo Source # | |||||||||||||||||||||||||||||||||
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
zlibCompressorLevel :: AttrLabelProxy "level" Source #