| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gio.Objects.FilterOutputStream
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
- newtype FilterOutputStream = FilterOutputStream (ManagedPtr FilterOutputStream)
- class (GObject o, IsDescendantOf FilterOutputStream o) => IsFilterOutputStream o
- toFilterOutputStream :: (MonadIO m, IsFilterOutputStream o) => o -> m FilterOutputStream
- type family ResolveFilterOutputStreamMethod (t :: Symbol) o where ...
- data FilterOutputStreamGetBaseStreamMethodInfo
- filterOutputStreamGetBaseStream :: (HasCallStack, MonadIO m, IsFilterOutputStream a) => a -> m OutputStream
- data FilterOutputStreamGetCloseBaseStreamMethodInfo
- filterOutputStreamGetCloseBaseStream :: (HasCallStack, MonadIO m, IsFilterOutputStream a) => a -> m Bool
- data FilterOutputStreamSetCloseBaseStreamMethodInfo
- filterOutputStreamSetCloseBaseStream :: (HasCallStack, MonadIO m, IsFilterOutputStream a) => a -> Bool -> m ()
- data FilterOutputStreamBaseStreamPropertyInfo
- constructFilterOutputStreamBaseStream :: (IsFilterOutputStream o, MonadIO m, IsOutputStream a) => a -> m (GValueConstruct o)
- filterOutputStreamBaseStream :: AttrLabelProxy "baseStream"
- getFilterOutputStreamBaseStream :: (MonadIO m, IsFilterOutputStream o) => o -> m OutputStream
- data FilterOutputStreamCloseBaseStreamPropertyInfo
- constructFilterOutputStreamCloseBaseStream :: (IsFilterOutputStream o, MonadIO m) => Bool -> m (GValueConstruct o)
- filterOutputStreamCloseBaseStream :: AttrLabelProxy "closeBaseStream"
- getFilterOutputStreamCloseBaseStream :: (MonadIO m, IsFilterOutputStream o) => o -> m Bool
Exported types
newtype FilterOutputStream Source #
Memory-managed wrapper type.
Constructors
| FilterOutputStream (ManagedPtr FilterOutputStream) |
Instances
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.
type family ResolveFilterOutputStreamMethod (t :: Symbol) o where ... Source #
Equations
getBaseStream
data FilterOutputStreamGetBaseStreamMethodInfo Source #
Instances
| (signature ~ m OutputStream, MonadIO m, IsFilterOutputStream a) => OverloadedMethod FilterOutputStreamGetBaseStreamMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.FilterOutputStream Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo FilterOutputStreamGetBaseStreamMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.FilterOutputStream Methods | |
filterOutputStreamGetBaseStream Source #
Arguments
| :: (HasCallStack, MonadIO m, IsFilterOutputStream a) | |
| => a |
|
| -> m OutputStream | Returns: a |
Gets the base stream for the filter stream.
getCloseBaseStream
data FilterOutputStreamGetCloseBaseStreamMethodInfo Source #
Instances
| (signature ~ m Bool, MonadIO m, IsFilterOutputStream a) => OverloadedMethod FilterOutputStreamGetCloseBaseStreamMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.FilterOutputStream Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo FilterOutputStreamGetCloseBaseStreamMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.FilterOutputStream Methods | |
filterOutputStreamGetCloseBaseStream Source #
Arguments
| :: (HasCallStack, MonadIO m, IsFilterOutputStream a) | |
| => a |
|
| -> m Bool | Returns: |
Returns whether the base stream will be closed when stream is
closed.
setCloseBaseStream
data FilterOutputStreamSetCloseBaseStreamMethodInfo Source #
Instances
| (signature ~ (Bool -> m ()), MonadIO m, IsFilterOutputStream a) => OverloadedMethod FilterOutputStreamSetCloseBaseStreamMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.FilterOutputStream Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo FilterOutputStreamSetCloseBaseStreamMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.FilterOutputStream Methods | |
filterOutputStreamSetCloseBaseStream Source #
Arguments
| :: (HasCallStack, MonadIO m, IsFilterOutputStream a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether the base stream will be closed when stream is closed.
Properties
baseStream
The underlying base stream on which the I/O ops will be done.
data FilterOutputStreamBaseStreamPropertyInfo Source #
Instances
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.
filterOutputStreamBaseStream :: AttrLabelProxy "baseStream" Source #
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.
data FilterOutputStreamCloseBaseStreamPropertyInfo Source #
Instances
| AttrInfo FilterOutputStreamCloseBaseStreamPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.FilterOutputStream Associated Types
Methods attrGet :: AttrBaseTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo o => o -> IO (AttrGetType FilterOutputStreamCloseBaseStreamPropertyInfo) # attrSet :: (AttrBaseTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo o, AttrSetTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo o, AttrSetTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo o, AttrTransferTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType FilterOutputStreamCloseBaseStreamPropertyInfo) # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps FilterOutputStreamCloseBaseStreamPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.FilterOutputStream | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType FilterOutputStreamCloseBaseStreamPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrLabel FilterOutputStreamCloseBaseStreamPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.FilterOutputStream | |||||||||||||||||||||||||||||||||
| type AttrOrigin FilterOutputStreamCloseBaseStreamPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferType FilterOutputStreamCloseBaseStreamPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint FilterOutputStreamCloseBaseStreamPropertyInfo Source # | |||||||||||||||||||||||||||||||||
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.
filterOutputStreamCloseBaseStream :: AttrLabelProxy "closeBaseStream" Source #
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