| 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.BufferedOutputStream
Description
Buffered output stream implements FilterOutputStream and provides
for buffered writes.
By default, GBufferedOutputStream's buffer size is set at 4 kilobytes.
To create a buffered output stream, use bufferedOutputStreamNew,
or bufferedOutputStreamNewSized to specify the buffer's size
at construction.
To get the size of a buffer within a buffered input stream, use
bufferedOutputStreamGetBufferSize. To change the size of a
buffered output stream's buffer, use bufferedOutputStreamSetBufferSize.
Note that the buffer's size cannot be reduced below the size of the data within the buffer.
Synopsis
- newtype BufferedOutputStream = BufferedOutputStream (ManagedPtr BufferedOutputStream)
- class (GObject o, IsDescendantOf BufferedOutputStream o) => IsBufferedOutputStream o
- toBufferedOutputStream :: (MonadIO m, IsBufferedOutputStream o) => o -> m BufferedOutputStream
- type family ResolveBufferedOutputStreamMethod (t :: Symbol) o where ...
- data BufferedOutputStreamGetAutoGrowMethodInfo
- bufferedOutputStreamGetAutoGrow :: (HasCallStack, MonadIO m, IsBufferedOutputStream a) => a -> m Bool
- data BufferedOutputStreamGetBufferSizeMethodInfo
- bufferedOutputStreamGetBufferSize :: (HasCallStack, MonadIO m, IsBufferedOutputStream a) => a -> m CSize
- bufferedOutputStreamNew :: (HasCallStack, MonadIO m, IsOutputStream a) => a -> m BufferedOutputStream
- bufferedOutputStreamNewSized :: (HasCallStack, MonadIO m, IsOutputStream a) => a -> CSize -> m BufferedOutputStream
- data BufferedOutputStreamSetAutoGrowMethodInfo
- bufferedOutputStreamSetAutoGrow :: (HasCallStack, MonadIO m, IsBufferedOutputStream a) => a -> Bool -> m ()
- data BufferedOutputStreamSetBufferSizeMethodInfo
- bufferedOutputStreamSetBufferSize :: (HasCallStack, MonadIO m, IsBufferedOutputStream a) => a -> CSize -> m ()
- data BufferedOutputStreamAutoGrowPropertyInfo
- bufferedOutputStreamAutoGrow :: AttrLabelProxy "autoGrow"
- constructBufferedOutputStreamAutoGrow :: (IsBufferedOutputStream o, MonadIO m) => Bool -> m (GValueConstruct o)
- getBufferedOutputStreamAutoGrow :: (MonadIO m, IsBufferedOutputStream o) => o -> m Bool
- setBufferedOutputStreamAutoGrow :: (MonadIO m, IsBufferedOutputStream o) => o -> Bool -> m ()
- data BufferedOutputStreamBufferSizePropertyInfo
- bufferedOutputStreamBufferSize :: AttrLabelProxy "bufferSize"
- constructBufferedOutputStreamBufferSize :: (IsBufferedOutputStream o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getBufferedOutputStreamBufferSize :: (MonadIO m, IsBufferedOutputStream o) => o -> m Word32
- setBufferedOutputStreamBufferSize :: (MonadIO m, IsBufferedOutputStream o) => o -> Word32 -> m ()
Exported types
newtype BufferedOutputStream Source #
Memory-managed wrapper type.
Constructors
| BufferedOutputStream (ManagedPtr BufferedOutputStream) |
Instances
class (GObject o, IsDescendantOf BufferedOutputStream o) => IsBufferedOutputStream o Source #
Type class for types which can be safely cast to BufferedOutputStream, for instance with toBufferedOutputStream.
Instances
| (GObject o, IsDescendantOf BufferedOutputStream o) => IsBufferedOutputStream o Source # | |
Defined in GI.Gio.Objects.BufferedOutputStream | |
toBufferedOutputStream :: (MonadIO m, IsBufferedOutputStream o) => o -> m BufferedOutputStream Source #
Cast to BufferedOutputStream, 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, canSeek, canTruncate, clearPending, close, closeAsync, closeFinish, flush, flushAsync, flushFinish, forceFloating, freezeNotify, getv, hasPending, isClosed, isClosing, isFloating, notify, notifyByPspec, ref, refSink, runDispose, seek, splice, spliceAsync, spliceFinish, stealData, stealQdata, tell, thawNotify, truncate, unref, watchClosure, write, writeAll, writeAllAsync, writeAllFinish, writeAsync, writeBytes, writeBytesAsync, writeBytesFinish, writeFinish, writev, writevAll, writevAllAsync, writevAllFinish, writevAsync, writevFinish.
Getters
getAutoGrow, getBaseStream, getBufferSize, getCloseBaseStream, getData, getProperty, getQdata.
Setters
setAutoGrow, setBufferSize, setCloseBaseStream, setData, setDataFull, setPending, setProperty.
type family ResolveBufferedOutputStreamMethod (t :: Symbol) o where ... Source #
Equations
getAutoGrow
data BufferedOutputStreamGetAutoGrowMethodInfo Source #
Instances
| (signature ~ m Bool, MonadIO m, IsBufferedOutputStream a) => OverloadedMethod BufferedOutputStreamGetAutoGrowMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.BufferedOutputStream Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo BufferedOutputStreamGetAutoGrowMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.BufferedOutputStream Methods | |
bufferedOutputStreamGetAutoGrow Source #
Arguments
| :: (HasCallStack, MonadIO m, IsBufferedOutputStream a) | |
| => a |
|
| -> m Bool | Returns: |
Checks if the buffer automatically grows as data is added.
getBufferSize
data BufferedOutputStreamGetBufferSizeMethodInfo Source #
Instances
| (signature ~ m CSize, MonadIO m, IsBufferedOutputStream a) => OverloadedMethod BufferedOutputStreamGetBufferSizeMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.BufferedOutputStream Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo BufferedOutputStreamGetBufferSizeMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.BufferedOutputStream Methods | |
bufferedOutputStreamGetBufferSize Source #
Arguments
| :: (HasCallStack, MonadIO m, IsBufferedOutputStream a) | |
| => a |
|
| -> m CSize | Returns: the current size of the buffer. |
Gets the size of the buffer in the stream.
new
bufferedOutputStreamNew Source #
Arguments
| :: (HasCallStack, MonadIO m, IsOutputStream a) | |
| => a |
|
| -> m BufferedOutputStream | Returns: a |
Creates a new buffered output stream for a base stream.
newSized
bufferedOutputStreamNewSized Source #
Arguments
| :: (HasCallStack, MonadIO m, IsOutputStream a) | |
| => a |
|
| -> CSize |
|
| -> m BufferedOutputStream | Returns: a |
Creates a new buffered output stream with a given buffer size.
setAutoGrow
data BufferedOutputStreamSetAutoGrowMethodInfo Source #
Instances
| (signature ~ (Bool -> m ()), MonadIO m, IsBufferedOutputStream a) => OverloadedMethod BufferedOutputStreamSetAutoGrowMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.BufferedOutputStream Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo BufferedOutputStreamSetAutoGrowMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.BufferedOutputStream Methods | |
bufferedOutputStreamSetAutoGrow Source #
Arguments
| :: (HasCallStack, MonadIO m, IsBufferedOutputStream a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether or not the stream's buffer should automatically grow.
If autoGrow is true, then each write will just make the buffer
larger, and you must manually flush the buffer to actually write out
the data to the underlying stream.
setBufferSize
data BufferedOutputStreamSetBufferSizeMethodInfo Source #
Instances
| (signature ~ (CSize -> m ()), MonadIO m, IsBufferedOutputStream a) => OverloadedMethod BufferedOutputStreamSetBufferSizeMethodInfo a signature Source # | |
Defined in GI.Gio.Objects.BufferedOutputStream Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo BufferedOutputStreamSetBufferSizeMethodInfo (a :: Type) Source # | |
Defined in GI.Gio.Objects.BufferedOutputStream Methods | |
bufferedOutputStreamSetBufferSize Source #
Arguments
| :: (HasCallStack, MonadIO m, IsBufferedOutputStream a) | |
| => a |
|
| -> CSize |
|
| -> m () |
Sets the size of the internal buffer to size.
Properties
autoGrow
Whether the buffer should automatically grow.
data BufferedOutputStreamAutoGrowPropertyInfo Source #
Instances
bufferedOutputStreamAutoGrow :: AttrLabelProxy "autoGrow" Source #
constructBufferedOutputStreamAutoGrow :: (IsBufferedOutputStream o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “auto-grow” property. This is rarely needed directly, but it is used by new.
getBufferedOutputStreamAutoGrow :: (MonadIO m, IsBufferedOutputStream o) => o -> m Bool Source #
Get the value of the “auto-grow” property.
When overloading is enabled, this is equivalent to
get bufferedOutputStream #autoGrow
setBufferedOutputStreamAutoGrow :: (MonadIO m, IsBufferedOutputStream o) => o -> Bool -> m () Source #
Set the value of the “auto-grow” property.
When overloading is enabled, this is equivalent to
setbufferedOutputStream [ #autoGrow:=value ]
bufferSize
The size of the backend buffer, in bytes.
data BufferedOutputStreamBufferSizePropertyInfo Source #
Instances
| AttrInfo BufferedOutputStreamBufferSizePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.BufferedOutputStream Associated Types
Methods attrGet :: AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo o => o -> IO (AttrGetType BufferedOutputStreamBufferSizePropertyInfo) # attrSet :: (AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo o, AttrSetTypeConstraint BufferedOutputStreamBufferSizePropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo o, AttrSetTypeConstraint BufferedOutputStreamBufferSizePropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo o, AttrTransferTypeConstraint BufferedOutputStreamBufferSizePropertyInfo b) => Proxy o -> b -> IO (AttrTransferType BufferedOutputStreamBufferSizePropertyInfo) # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps BufferedOutputStreamBufferSizePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.BufferedOutputStream | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType BufferedOutputStreamBufferSizePropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrLabel BufferedOutputStreamBufferSizePropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Gio.Objects.BufferedOutputStream | |||||||||||||||||||||||||||||||||
| type AttrOrigin BufferedOutputStreamBufferSizePropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint BufferedOutputStreamBufferSizePropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferType BufferedOutputStreamBufferSizePropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint BufferedOutputStreamBufferSizePropertyInfo Source # | |||||||||||||||||||||||||||||||||
bufferedOutputStreamBufferSize :: AttrLabelProxy "bufferSize" Source #
constructBufferedOutputStreamBufferSize :: (IsBufferedOutputStream o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “buffer-size” property. This is rarely needed directly, but it is used by new.
getBufferedOutputStreamBufferSize :: (MonadIO m, IsBufferedOutputStream o) => o -> m Word32 Source #
Get the value of the “buffer-size” property.
When overloading is enabled, this is equivalent to
get bufferedOutputStream #bufferSize
setBufferedOutputStreamBufferSize :: (MonadIO m, IsBufferedOutputStream o) => o -> Word32 -> m () Source #
Set the value of the “buffer-size” property.
When overloading is enabled, this is equivalent to
setbufferedOutputStream [ #bufferSize:=value ]