GI.Gio.Objects.FilterOutputStream

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.

Exported types

newtype FilterOutputStream

Memory-managed wrapper type.

Constructors

FilterOutputStream (ManagedPtr FilterOutputStream)

Instances

Eq FilterOutputStream

Defined in GI.Gio.Objects.FilterOutputStream

Methods

(==) :: FilterOutputStream -> FilterOutputStream -> Bool

(/=) :: FilterOutputStream -> FilterOutputStream -> Bool

GObject FilterOutputStream

Defined in GI.Gio.Objects.FilterOutputStream

Methods

gobjectType :: IO GType

IsGValue FilterOutputStream

Convert FilterOutputStream to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.FilterOutputStream

Methods

toGValue :: FilterOutputStream -> IO GValue

fromGValue :: GValue -> IO FilterOutputStream

HasParentTypes FilterOutputStream

Defined in GI.Gio.Objects.FilterOutputStream

type ParentTypes FilterOutputStream

Defined in GI.Gio.Objects.FilterOutputStream

type ParentTypes FilterOutputStream = '[OutputStream, Object]

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

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

Instances

(GObject o, IsDescendantOf FilterOutputStream o) => IsFilterOutputStream o

Defined in GI.Gio.Objects.FilterOutputStream

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

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

noFilterOutputStream :: Maybe FilterOutputStream

A convenience alias for Nothing :: Maybe FilterOutputStream.

Methods

Overloaded methods

getBaseStream

filterOutputStreamGetBaseStream

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

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

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)

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

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)

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

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

get filterOutputStream #closeBaseStream