Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
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
- newtype FilterOutputStream = FilterOutputStream (ManagedPtr FilterOutputStream)
- class (GObject o, IsDescendantOf FilterOutputStream o) => IsFilterOutputStream o
- toFilterOutputStream :: (MonadIO m, IsFilterOutputStream o) => o -> m FilterOutputStream
- filterOutputStreamGetBaseStream :: (HasCallStack, MonadIO m, IsFilterOutputStream a) => a -> m OutputStream
- filterOutputStreamGetCloseBaseStream :: (HasCallStack, MonadIO m, IsFilterOutputStream a) => a -> m Bool
- filterOutputStreamSetCloseBaseStream :: (HasCallStack, MonadIO m, IsFilterOutputStream a) => a -> Bool -> m ()
- constructFilterOutputStreamBaseStream :: (IsFilterOutputStream o, MonadIO m, IsOutputStream a) => a -> m (GValueConstruct o)
- getFilterOutputStreamBaseStream :: (MonadIO m, IsFilterOutputStream o) => o -> m OutputStream
- constructFilterOutputStreamCloseBaseStream :: (IsFilterOutputStream o, MonadIO m) => Bool -> m (GValueConstruct o)
- getFilterOutputStreamCloseBaseStream :: (MonadIO m, IsFilterOutputStream o) => o -> m Bool
Exported types
newtype FilterOutputStream Source #
Memory-managed wrapper type.
Instances
Eq FilterOutputStream Source # | |
Defined in GI.Gio.Objects.FilterOutputStream (==) :: FilterOutputStream -> FilterOutputStream -> Bool # (/=) :: FilterOutputStream -> FilterOutputStream -> Bool # | |
GObject FilterOutputStream Source # | |
Defined in GI.Gio.Objects.FilterOutputStream | |
ManagedPtrNewtype FilterOutputStream Source # | |
TypedObject FilterOutputStream Source # | |
Defined in GI.Gio.Objects.FilterOutputStream | |
HasParentTypes FilterOutputStream Source # | |
Defined in GI.Gio.Objects.FilterOutputStream | |
IsGValue (Maybe FilterOutputStream) Source # | Convert |
Defined in GI.Gio.Objects.FilterOutputStream gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe FilterOutputStream -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe FilterOutputStream) # | |
type ParentTypes FilterOutputStream Source # | |
Defined in GI.Gio.Objects.FilterOutputStream |
class (GObject o, IsDescendantOf FilterOutputStream o) => IsFilterOutputStream o Source #
Type class for types which can be safely cast to FilterOutputStream
, for instance with toFilterOutputStream
.
Instances
(GObject o, IsDescendantOf FilterOutputStream o) => IsFilterOutputStream o Source # | |
Defined in GI.Gio.Objects.FilterOutputStream |
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
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, clearPending, close, closeAsync, closeFinish, flush, flushAsync, flushFinish, forceFloating, freezeNotify, getv, hasPending, isClosed, isClosing, isFloating, notify, notifyByPspec, ref, refSink, runDispose, splice, spliceAsync, spliceFinish, stealData, stealQdata, thawNotify, unref, watchClosure, write, writeAll, writeAllAsync, writeAllFinish, writeAsync, writeBytes, writeBytesAsync, writeBytesFinish, writeFinish, writev, writevAll, writevAllAsync, writevAllFinish, writevAsync, writevFinish.
Getters
getBaseStream, getCloseBaseStream, getData, getProperty, getQdata.
Setters
setCloseBaseStream, setData, setDataFull, setPending, setProperty.
getBaseStream
filterOutputStreamGetBaseStream Source #
:: (HasCallStack, MonadIO m, IsFilterOutputStream a) | |
=> a |
|
-> m OutputStream | Returns: a |
Gets the base stream for the filter stream.
getCloseBaseStream
filterOutputStreamGetCloseBaseStream Source #
:: (HasCallStack, MonadIO m, IsFilterOutputStream a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the base stream will be closed when stream
is
closed.
setCloseBaseStream
filterOutputStreamSetCloseBaseStream Source #
:: (HasCallStack, MonadIO m, IsFilterOutputStream a) | |
=> a |
|
-> Bool |
|
-> 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, MonadIO m, IsOutputStream a) => a -> m (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
Whether the base stream should be closed when the filter stream is closed.
constructFilterOutputStreamCloseBaseStream :: (IsFilterOutputStream o, MonadIO m) => Bool -> m (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