| 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.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.
- newtype FilterInputStream = FilterInputStream (ManagedPtr FilterInputStream)
- class GObject o => IsFilterInputStream o
- toFilterInputStream :: IsFilterInputStream o => o -> IO FilterInputStream
- noFilterInputStream :: Maybe FilterInputStream
- data FilterInputStreamGetBaseStreamMethodInfo
- filterInputStreamGetBaseStream :: (HasCallStack, MonadIO m, IsFilterInputStream a) => a -> m InputStream
- data FilterInputStreamGetCloseBaseStreamMethodInfo
- filterInputStreamGetCloseBaseStream :: (HasCallStack, MonadIO m, IsFilterInputStream a) => a -> m Bool
- data FilterInputStreamSetCloseBaseStreamMethodInfo
- filterInputStreamSetCloseBaseStream :: (HasCallStack, MonadIO m, IsFilterInputStream a) => a -> Bool -> m ()
- data FilterInputStreamBaseStreamPropertyInfo
- constructFilterInputStreamBaseStream :: (IsFilterInputStream o, IsInputStream a) => a -> IO (GValueConstruct o)
- filterInputStreamBaseStream :: AttrLabelProxy "baseStream"
- getFilterInputStreamBaseStream :: (MonadIO m, IsFilterInputStream o) => o -> m InputStream
- data FilterInputStreamCloseBaseStreamPropertyInfo
- constructFilterInputStreamCloseBaseStream :: IsFilterInputStream o => Bool -> IO (GValueConstruct o)
- filterInputStreamCloseBaseStream :: AttrLabelProxy "closeBaseStream"
- getFilterInputStreamCloseBaseStream :: (MonadIO m, IsFilterInputStream o) => o -> m Bool
- setFilterInputStreamCloseBaseStream :: (MonadIO m, IsFilterInputStream o) => o -> Bool -> m ()
Exported types
newtype FilterInputStream Source #
Constructors
| FilterInputStream (ManagedPtr FilterInputStream) |
Instances
| GObject FilterInputStream Source # | |
| IsObject FilterInputStream Source # | |
| IsInputStream FilterInputStream Source # | |
| IsFilterInputStream FilterInputStream Source # | |
| ((~) * info (ResolveFilterInputStreamMethod t FilterInputStream), MethodInfo * info FilterInputStream p) => IsLabel t (FilterInputStream -> p) Source # | |
| ((~) * info (ResolveFilterInputStreamMethod t FilterInputStream), MethodInfo * info FilterInputStream p) => IsLabelProxy t (FilterInputStream -> p) Source # | |
| HasAttributeList * FilterInputStream Source # | |
| type AttributeList FilterInputStream Source # | |
| type SignalList FilterInputStream Source # | |
class GObject o => IsFilterInputStream o Source #
toFilterInputStream :: IsFilterInputStream o => o -> IO FilterInputStream Source #
Methods
getBaseStream
data FilterInputStreamGetBaseStreamMethodInfo Source #
Instances
| ((~) * signature (m InputStream), MonadIO m, IsFilterInputStream a) => MethodInfo * FilterInputStreamGetBaseStreamMethodInfo a signature Source # | |
filterInputStreamGetBaseStream Source #
Arguments
| :: (HasCallStack, MonadIO m, IsFilterInputStream a) | |
| => a |
|
| -> m InputStream | Returns: a |
Gets the base stream for the filter stream.
getCloseBaseStream
data FilterInputStreamGetCloseBaseStreamMethodInfo Source #
Instances
| ((~) * signature (m Bool), MonadIO m, IsFilterInputStream a) => MethodInfo * FilterInputStreamGetCloseBaseStreamMethodInfo a signature Source # | |
filterInputStreamGetCloseBaseStream Source #
Arguments
| :: (HasCallStack, MonadIO m, IsFilterInputStream a) | |
| => a |
|
| -> m Bool | Returns: |
Returns whether the base stream will be closed when stream is
closed.
setCloseBaseStream
data FilterInputStreamSetCloseBaseStreamMethodInfo Source #
Instances
| ((~) * signature (Bool -> m ()), MonadIO m, IsFilterInputStream a) => MethodInfo * FilterInputStreamSetCloseBaseStreamMethodInfo a signature Source # | |
filterInputStreamSetCloseBaseStream Source #
Arguments
| :: (HasCallStack, MonadIO m, IsFilterInputStream a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether the base stream will be closed when stream is closed.
Properties
baseStream
data FilterInputStreamBaseStreamPropertyInfo Source #
Instances
constructFilterInputStreamBaseStream :: (IsFilterInputStream o, IsInputStream a) => a -> IO (GValueConstruct o) Source #
filterInputStreamBaseStream :: AttrLabelProxy "baseStream" Source #
getFilterInputStreamBaseStream :: (MonadIO m, IsFilterInputStream o) => o -> m InputStream Source #
closeBaseStream
data FilterInputStreamCloseBaseStreamPropertyInfo Source #
Instances
constructFilterInputStreamCloseBaseStream :: IsFilterInputStream o => Bool -> IO (GValueConstruct o) Source #
filterInputStreamCloseBaseStream :: AttrLabelProxy "closeBaseStream" Source #
getFilterInputStreamCloseBaseStream :: (MonadIO m, IsFilterInputStream o) => o -> m Bool Source #
setFilterInputStreamCloseBaseStream :: (MonadIO m, IsFilterInputStream o) => o -> Bool -> m () Source #