gi-gio-2.0.18: Gio bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Objects.ZlibCompressor

Contents

Description

Zlib decompression

Synopsis

Exported types

class GObject o => IsZlibCompressor o Source #

Type class for types which can be safely cast to ZlibCompressor, for instance with toZlibCompressor.

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

getFileInfo

zlibCompressorGetFileInfo Source #

Arguments

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

compressor: a ZlibCompressor

-> m FileInfo

Returns: a FileInfo, or Nothing

Returns the ZlibCompressor:file-info property.

Since: 2.26

new

zlibCompressorNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ZlibCompressorFormat

format: The format to use for the compressed data

-> Int32

level: compression level (0-9), -1 for default

-> m ZlibCompressor

Returns: a new ZlibCompressor

Creates a new ZlibCompressor.

Since: 2.24

setFileInfo

zlibCompressorSetFileInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsZlibCompressor a, IsFileInfo b) 
=> a

compressor: a ZlibCompressor

-> Maybe b

fileInfo: a FileInfo

-> 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, IsFileInfo a) => a -> IO (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

set zlibCompressor [ #fileInfo := value ]

format

No description available in the introspection data.

constructZlibCompressorFormat :: IsZlibCompressor 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.

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 => Int32 -> IO (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