GI.Gio.Objects.BufferedOutputStream

Buffered output stream implements FilterOutputStream and provides for buffered writes.

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

Constructors

BufferedOutputStream (ManagedPtr BufferedOutputStream)

Instances

GObject BufferedOutputStream

Methods

gobjectType :: BufferedOutputStream -> IO GType

IsObject BufferedOutputStream

IsOutputStream BufferedOutputStream

IsFilterOutputStream BufferedOutputStream

IsSeekable BufferedOutputStream

IsBufferedOutputStream BufferedOutputStream

((~) * info (ResolveBufferedOutputStreamMethod t BufferedOutputStream), MethodInfo * info BufferedOutputStream p) => IsLabel t (BufferedOutputStream -> p)

Methods

fromLabel :: Proxy# Symbol t -> BufferedOutputStream -> p

((~) * info (ResolveBufferedOutputStreamMethod t BufferedOutputStream), MethodInfo * info BufferedOutputStream p) => IsLabelProxy t (BufferedOutputStream -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> BufferedOutputStream -> p

HasAttributeList * BufferedOutputStream

type AttributeList BufferedOutputStream

type AttributeList BufferedOutputStream

type SignalList BufferedOutputStream

type SignalList BufferedOutputStream

class GObject o => IsBufferedOutputStream o

Instances

(GObject a, UnknownAncestorError Constraint BufferedOutputStream a) => IsBufferedOutputStream a

IsBufferedOutputStream BufferedOutputStream

toBufferedOutputStream :: IsBufferedOutputStream o => o -> IO BufferedOutputStream

noBufferedOutputStream :: Maybe BufferedOutputStream

Methods

getAutoGrow

data BufferedOutputStreamGetAutoGrowMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsBufferedOutputStream a) => MethodInfo * BufferedOutputStreamGetAutoGrowMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BufferedOutputStreamGetAutoGrowMethodInfo a -> signature -> s

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

data BufferedOutputStreamGetBufferSizeMethodInfo

Instances

((~) * signature (m Word64), MonadIO m, IsBufferedOutputStream a) => MethodInfo * BufferedOutputStreamGetBufferSizeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BufferedOutputStreamGetBufferSizeMethodInfo a -> signature -> s

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

data BufferedOutputStreamSetAutoGrowMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsBufferedOutputStream a) => MethodInfo * BufferedOutputStreamSetAutoGrowMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BufferedOutputStreamSetAutoGrowMethodInfo a -> signature -> s

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

data BufferedOutputStreamSetBufferSizeMethodInfo

Instances

((~) * signature (Word64 -> m ()), MonadIO m, IsBufferedOutputStream a) => MethodInfo * BufferedOutputStreamSetBufferSizeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy BufferedOutputStreamSetBufferSizeMethodInfo a -> signature -> s

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

data BufferedOutputStreamAutoGrowPropertyInfo

Instances

AttrInfo BufferedOutputStreamAutoGrowPropertyInfo

Associated Types

type AttrAllowedOps BufferedOutputStreamAutoGrowPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo :: * -> Constraint

type AttrGetType BufferedOutputStreamAutoGrowPropertyInfo :: *

type AttrLabel BufferedOutputStreamAutoGrowPropertyInfo :: Symbol

type AttrOrigin BufferedOutputStreamAutoGrowPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo o => Proxy * BufferedOutputStreamAutoGrowPropertyInfo -> o -> IO (AttrGetType BufferedOutputStreamAutoGrowPropertyInfo)

attrSet :: (AttrBaseTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo o, AttrSetTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo b) => Proxy * BufferedOutputStreamAutoGrowPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo o => Proxy * BufferedOutputStreamAutoGrowPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo o, AttrSetTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo b) => Proxy * BufferedOutputStreamAutoGrowPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin BufferedOutputStreamAutoGrowPropertyInfo

type AttrOrigin BufferedOutputStreamAutoGrowPropertyInfo = BufferedOutputStream

type AttrLabel BufferedOutputStreamAutoGrowPropertyInfo

type AttrLabel BufferedOutputStreamAutoGrowPropertyInfo = "auto-grow"

type AttrGetType BufferedOutputStreamAutoGrowPropertyInfo

type AttrGetType BufferedOutputStreamAutoGrowPropertyInfo = Bool

type AttrBaseTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo

type AttrBaseTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo = IsBufferedOutputStream

type AttrSetTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo

type AttrSetTypeConstraint BufferedOutputStreamAutoGrowPropertyInfo = * ~ Bool

type AttrAllowedOps BufferedOutputStreamAutoGrowPropertyInfo

type AttrAllowedOps BufferedOutputStreamAutoGrowPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

bufferedOutputStreamAutoGrow :: AttrLabelProxy "autoGrow"

constructBufferedOutputStreamAutoGrow :: IsBufferedOutputStream o => Bool -> IO (GValueConstruct o)

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

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

bufferSize

data BufferedOutputStreamBufferSizePropertyInfo

Instances

AttrInfo BufferedOutputStreamBufferSizePropertyInfo

Associated Types

type AttrAllowedOps BufferedOutputStreamBufferSizePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint BufferedOutputStreamBufferSizePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo :: * -> Constraint

type AttrGetType BufferedOutputStreamBufferSizePropertyInfo :: *

type AttrLabel BufferedOutputStreamBufferSizePropertyInfo :: Symbol

type AttrOrigin BufferedOutputStreamBufferSizePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo o => Proxy * BufferedOutputStreamBufferSizePropertyInfo -> o -> IO (AttrGetType BufferedOutputStreamBufferSizePropertyInfo)

attrSet :: (AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo o, AttrSetTypeConstraint BufferedOutputStreamBufferSizePropertyInfo b) => Proxy * BufferedOutputStreamBufferSizePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo o => Proxy * BufferedOutputStreamBufferSizePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo o, AttrSetTypeConstraint BufferedOutputStreamBufferSizePropertyInfo b) => Proxy * BufferedOutputStreamBufferSizePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin BufferedOutputStreamBufferSizePropertyInfo

type AttrOrigin BufferedOutputStreamBufferSizePropertyInfo = BufferedOutputStream

type AttrLabel BufferedOutputStreamBufferSizePropertyInfo

type AttrLabel BufferedOutputStreamBufferSizePropertyInfo = "buffer-size"

type AttrGetType BufferedOutputStreamBufferSizePropertyInfo

type AttrGetType BufferedOutputStreamBufferSizePropertyInfo = Word32

type AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo

type AttrBaseTypeConstraint BufferedOutputStreamBufferSizePropertyInfo = IsBufferedOutputStream

type AttrSetTypeConstraint BufferedOutputStreamBufferSizePropertyInfo

type AttrSetTypeConstraint BufferedOutputStreamBufferSizePropertyInfo = * ~ Word32

type AttrAllowedOps BufferedOutputStreamBufferSizePropertyInfo

type AttrAllowedOps BufferedOutputStreamBufferSizePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

bufferedOutputStreamBufferSize :: AttrLabelProxy "bufferSize"

constructBufferedOutputStreamBufferSize :: IsBufferedOutputStream o => Word32 -> IO (GValueConstruct o)

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

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