gi-gio-2.0.24: Gio bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Objects.FilterOutputStream

Contents

Description

Base class for output stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering operations are character set conversion, compression and byte order flipping.

Synopsis

Exported types

class (GObject o, IsDescendantOf FilterOutputStream o) => IsFilterOutputStream o Source #

Type class for types which can be safely cast to FilterOutputStream, for instance with toFilterOutputStream.

toFilterOutputStream :: (MonadIO m, IsFilterOutputStream o) => o -> m FilterOutputStream Source #

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

Methods

getBaseStream

filterOutputStreamGetBaseStream Source #

Arguments

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

stream: a FilterOutputStream.

-> m OutputStream

Returns: a OutputStream.

Gets the base stream for the filter stream.

getCloseBaseStream

filterOutputStreamGetCloseBaseStream Source #

Arguments

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

stream: a FilterOutputStream.

-> m Bool

Returns: True if the base stream will be closed.

Returns whether the base stream will be closed when stream is closed.

setCloseBaseStream

filterOutputStreamSetCloseBaseStream Source #

Arguments

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

stream: a FilterOutputStream.

-> Bool

closeBase: True to close the base stream.

-> m () 

Sets whether the base stream will be closed when stream is closed.

Properties

baseStream

No description available in the introspection data.

constructFilterOutputStreamBaseStream :: (IsFilterOutputStream o, IsOutputStream a) => a -> IO (GValueConstruct o) Source #

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

getFilterOutputStreamBaseStream :: (MonadIO m, IsFilterOutputStream o) => o -> m OutputStream Source #

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

get filterOutputStream #baseStream

closeBaseStream

No description available in the introspection data.

constructFilterOutputStreamCloseBaseStream :: IsFilterOutputStream o => Bool -> IO (GValueConstruct o) Source #

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

getFilterOutputStreamCloseBaseStream :: (MonadIO m, IsFilterOutputStream o) => o -> m Bool Source #

Get the value of the “close-base-stream” property. When overloading is enabled, this is equivalent to

get filterOutputStream #closeBaseStream