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.FilterInputStream

Contents

Description

Base class for input 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

toFilterInputStream :: (MonadIO m, IsFilterInputStream o) => o -> m FilterInputStream Source #

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

Methods

getBaseStream

filterInputStreamGetBaseStream Source #

Arguments

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

stream: a FilterInputStream.

-> m InputStream

Returns: a InputStream.

Gets the base stream for the filter stream.

getCloseBaseStream

filterInputStreamGetCloseBaseStream Source #

Arguments

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

stream: a FilterInputStream.

-> m Bool

Returns: True if the base stream will be closed.

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

setCloseBaseStream

filterInputStreamSetCloseBaseStream Source #

Arguments

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

stream: a FilterInputStream.

-> 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.

constructFilterInputStreamBaseStream :: (IsFilterInputStream o, IsInputStream 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.

getFilterInputStreamBaseStream :: (MonadIO m, IsFilterInputStream o) => o -> m InputStream Source #

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

get filterInputStream #baseStream

closeBaseStream

No description available in the introspection data.

constructFilterInputStreamCloseBaseStream :: IsFilterInputStream 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.

getFilterInputStreamCloseBaseStream :: (MonadIO m, IsFilterInputStream o) => o -> m Bool Source #

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

get filterInputStream #closeBaseStream

setFilterInputStreamCloseBaseStream :: (MonadIO m, IsFilterInputStream o) => o -> Bool -> m () Source #

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

set filterInputStream [ #closeBaseStream := value ]