| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
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
- newtype FilterOutputStream = FilterOutputStream (ManagedPtr FilterOutputStream)
- class GObject o => IsFilterOutputStream o
- toFilterOutputStream :: (MonadIO m, IsFilterOutputStream o) => o -> m FilterOutputStream
- noFilterOutputStream :: Maybe 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, IsOutputStream a) => a -> IO (GValueConstruct o)
- getFilterOutputStreamBaseStream :: (MonadIO m, IsFilterOutputStream o) => o -> m OutputStream
- constructFilterOutputStreamCloseBaseStream :: IsFilterOutputStream o => Bool -> IO (GValueConstruct o)
- getFilterOutputStreamCloseBaseStream :: (MonadIO m, IsFilterOutputStream o) => o -> m Bool
Exported types
newtype FilterOutputStream Source #
Memory-managed wrapper type.
Constructors
| FilterOutputStream (ManagedPtr FilterOutputStream) |
Instances
| GObject FilterOutputStream Source # | |
Defined in GI.Gio.Objects.FilterOutputStream Methods gobjectType :: FilterOutputStream -> IO GType # | |
| IsObject FilterOutputStream Source # | |
Defined in GI.Gio.Objects.FilterOutputStream | |
| IsFilterOutputStream FilterOutputStream Source # | |
Defined in GI.Gio.Objects.FilterOutputStream | |
| IsOutputStream FilterOutputStream Source # | |
Defined in GI.Gio.Objects.FilterOutputStream | |
class GObject o => IsFilterOutputStream o Source #
Type class for types which can be safely cast to FilterOutputStream, for instance with toFilterOutputStream.
Instances
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.
noFilterOutputStream :: Maybe FilterOutputStream Source #
A convenience alias for Nothing :: Maybe FilterOutputStream.
Methods
getBaseStream
filterOutputStreamGetBaseStream Source #
Arguments
| :: (HasCallStack, MonadIO m, IsFilterOutputStream a) | |
| => a |
|
| -> m OutputStream | Returns: a |
Gets the base stream for the filter stream.
getCloseBaseStream
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
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
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