GI.Gio.Objects.BufferedOutputStream

Buffered output stream implements FilterOutputStream and provides for buffered writes.

By default, BufferedOutputStream'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.

Exported types

newtype BufferedOutputStream

Memory-managed wrapper type.

Constructors

BufferedOutputStream (ManagedPtr BufferedOutputStream)

Instances

Eq BufferedOutputStream

Defined in GI.Gio.Objects.BufferedOutputStream

Methods

(==) :: BufferedOutputStream -> BufferedOutputStream -> Bool

(/=) :: BufferedOutputStream -> BufferedOutputStream -> Bool

GObject BufferedOutputStream

Defined in GI.Gio.Objects.BufferedOutputStream

ManagedPtrNewtype BufferedOutputStream

Defined in GI.Gio.Objects.BufferedOutputStream

Methods

toManagedPtr :: BufferedOutputStream -> ManagedPtr BufferedOutputStream

TypedObject BufferedOutputStream

Defined in GI.Gio.Objects.BufferedOutputStream

Methods

glibType :: IO GType

HasParentTypes BufferedOutputStream

Defined in GI.Gio.Objects.BufferedOutputStream

IsGValue (Maybe BufferedOutputStream)

Convert BufferedOutputStream to and from GValue. See toGValue and fromGValue.

Defined in GI.Gio.Objects.BufferedOutputStream

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe BufferedOutputStream -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe BufferedOutputStream)

type ParentTypes BufferedOutputStream

Defined in GI.Gio.Objects.BufferedOutputStream

type ParentTypes BufferedOutputStream = '[FilterOutputStream, OutputStream, Object, Seekable]

class (GObject o, IsDescendantOf BufferedOutputStream o) => IsBufferedOutputStream o

Type class for types which can be safely cast to BufferedOutputStream, for instance with toBufferedOutputStream.

Instances

(GObject o, IsDescendantOf BufferedOutputStream o) => IsBufferedOutputStream o

Defined in GI.Gio.Objects.BufferedOutputStream

toBufferedOutputStream :: (MonadIO m, IsBufferedOutputStream o) => o -> m BufferedOutputStream

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.

getAutoGrow

bufferedOutputStreamGetAutoGrow

Arguments

:: (HasCallStack, MonadIO m, IsBufferedOutputStream a)

=> a

stream: a BufferedOutputStream.

-> m Bool

Returns: True if the stream's buffer automatically grows, False otherwise.

Checks if the buffer automatically grows as data is added.

getBufferSize

bufferedOutputStreamGetBufferSize

Arguments

:: (HasCallStack, MonadIO m, IsBufferedOutputStream a)

=> a

stream: a BufferedOutputStream.

-> m Word64

Returns: the current size of the buffer.

Gets the size of the buffer in the stream.

new

bufferedOutputStreamNew

Arguments

:: (HasCallStack, MonadIO m, IsOutputStream a)

=> a

baseStream: a OutputStream.

-> m BufferedOutputStream

Returns: a OutputStream for the given baseStream.

Creates a new buffered output stream for a base stream.

newSized

bufferedOutputStreamNewSized

Arguments

:: (HasCallStack, MonadIO m, IsOutputStream a)

=> a

baseStream: a OutputStream.

-> Word64

size: a gsize.

-> m BufferedOutputStream

Returns: a OutputStream with an internal buffer set to size.

Creates a new buffered output stream with a given buffer size.

setAutoGrow

bufferedOutputStreamSetAutoGrow

Arguments

:: (HasCallStack, MonadIO m, IsBufferedOutputStream a)

=> a

stream: a BufferedOutputStream.

-> Bool

autoGrow: 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

bufferedOutputStreamSetBufferSize

Arguments

:: (HasCallStack, MonadIO m, IsBufferedOutputStream a)

=> a

stream: a BufferedOutputStream.

-> Word64

size: a gsize.

-> m ()

Sets the size of the internal buffer to size.

Properties

autoGrow

No description available in the introspection data.

constructBufferedOutputStreamAutoGrow :: (IsBufferedOutputStream o, MonadIO m) => Bool -> m (GValueConstruct o)

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

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 ()

Set the value of the “auto-grow” property. When overloading is enabled, this is equivalent to

set bufferedOutputStream [ #autoGrow := value ]

bufferSize

No description available in the introspection data.

constructBufferedOutputStreamBufferSize :: (IsBufferedOutputStream o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

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 ()

Set the value of the “buffer-size” property. When overloading is enabled, this is equivalent to

set bufferedOutputStream [ #bufferSize := value ]