OutputStream

gio.output_stream.OutputStream is a base class for implementing streaming output.

It has functions to write to a stream (gio.output_stream.OutputStream.write), to close a stream (gio.output_stream.OutputStream.close) and to flush pending writes (gio.output_stream.OutputStream.flush).

To copy the content of an input stream to an output stream without manually handling the reads and writes, use gio.output_stream.OutputStream.splice.

See the documentation for gio.iostream.IOStream for details of thread safety of streaming APIs.

All of these functions have async variants too.

All classes derived from gio.output_stream.OutputStream *should* implement synchronous writing, splicing, flushing and closing streams, but *may* implement asynchronous versions.

class OutputStream : ObjectG {}

Members

Functions

clearPending
void clearPending()

Clears the pending flag on stream.

close
bool close(gio.cancellable.Cancellable cancellable)

Closes the stream, releasing resources related to it.

closeAsync
void closeAsync(int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.closeFinish to get the result of the operation.

closeFinish
bool closeFinish(gio.async_result.AsyncResult result)

Closes an output stream.

flush
bool flush(gio.cancellable.Cancellable cancellable)

Forces a write of all user-space buffered data for the given stream. Will block during the operation. Closing the stream will implicitly cause a flush.

flushAsync
void flushAsync(int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Forces an asynchronous write of all user-space buffered data for the given stream. For behaviour details see gio.output_stream.OutputStream.flush.

flushFinish
bool flushFinish(gio.async_result.AsyncResult result)

Finishes flushing an output stream.

hasPending
bool hasPending()

Checks if an output stream has pending actions.

isClosed
bool isClosed()

Checks if an output stream has already been closed.

isClosing
bool isClosing()

Checks if an output stream is being closed. This can be used inside e.g. a flush implementation to see if the flush (or other i/o operation) is called from within the closing operation.

setPending
bool setPending()

Sets stream to have actions pending. If the pending flag is already set or stream is closed, it will return false and set error.

splice
ptrdiff_t splice(gio.input_stream.InputStream source, gio.types.OutputStreamSpliceFlags flags, gio.cancellable.Cancellable cancellable)

Splices an input stream into an output stream.

spliceAsync
void spliceAsync(gio.input_stream.InputStream source, gio.types.OutputStreamSpliceFlags flags, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Splices a stream asynchronously. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.spliceFinish to get the result of the operation.

spliceFinish
ptrdiff_t spliceFinish(gio.async_result.AsyncResult result)

Finishes an asynchronous stream splice operation.

write
ptrdiff_t write(ubyte[] buffer, gio.cancellable.Cancellable cancellable)

Tries to write count bytes from buffer into the stream. Will block during the operation.

writeAll
bool writeAll(ubyte[] buffer, size_t bytesWritten, gio.cancellable.Cancellable cancellable)

Tries to write count bytes from buffer into the stream. Will block during the operation.

writeAllAsync
void writeAllAsync(ubyte[] buffer, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.writeAllFinish to get the result of the operation.

writeAllFinish
bool writeAllFinish(gio.async_result.AsyncResult result, size_t bytesWritten)

Finishes an asynchronous stream write operation started with gio.output_stream.OutputStream.writeAllAsync.

writeAsync
void writeAsync(ubyte[] buffer, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Request an asynchronous write of count bytes from buffer into the stream. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.writeFinish to get the result of the operation.

writeBytes
ptrdiff_t writeBytes(glib.bytes.Bytes bytes, gio.cancellable.Cancellable cancellable)

A wrapper function for gio.output_stream.OutputStream.write which takes a #GBytes as input. This can be more convenient for use by language bindings or in other cases where the refcounted nature of #GBytes is helpful over a bare pointer interface.

writeBytesAsync
void writeBytesAsync(glib.bytes.Bytes bytes, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

This function is similar to gio.output_stream.OutputStream.writeAsync, but takes a #GBytes as input. Due to the refcounted nature of #GBytes, this allows the stream to avoid taking a copy of the data.

writeBytesFinish
ptrdiff_t writeBytesFinish(gio.async_result.AsyncResult result)

Finishes a stream write-from-#GBytes operation.

writeFinish
ptrdiff_t writeFinish(gio.async_result.AsyncResult result)

Finishes a stream write operation.

writev
bool writev(gio.types.OutputVector[] vectors, size_t bytesWritten, gio.cancellable.Cancellable cancellable)

Tries to write the bytes contained in the n_vectors vectors into the stream. Will block during the operation.

writevAll
bool writevAll(gio.types.OutputVector[] vectors, size_t bytesWritten, gio.cancellable.Cancellable cancellable)

Tries to write the bytes contained in the n_vectors vectors into the stream. Will block during the operation.

writevAllAsync
void writevAllAsync(gio.types.OutputVector[] vectors, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Request an asynchronous write of the bytes contained in the n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.writevAllFinish to get the result of the operation.

writevAllFinish
bool writevAllFinish(gio.async_result.AsyncResult result, size_t bytesWritten)

Finishes an asynchronous stream write operation started with gio.output_stream.OutputStream.writevAllAsync.

writevAsync
void writevAsync(gio.types.OutputVector[] vectors, int ioPriority, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback)

Request an asynchronous write of the bytes contained in n_vectors vectors into the stream. When the operation is finished callback will be called. You can then call gio.output_stream.OutputStream.writevFinish to get the result of the operation.

writevFinish
bool writevFinish(gio.async_result.AsyncResult result, size_t bytesWritten)

Finishes a stream writev operation.

Inherited Members

From ObjectG

setGObject
void setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectG wrapper.

cPtr
void* cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

ref_
void* ref_(void* gObj)

Calls g_object_ref() on a GObject.

unref
unref(void* gObj)

Calls g_object_unref() on a GObject.

getType
GType getType()

Get the GType of an object.

gType
GType gType [@property getter]

GObject GType property.

self
ObjectG self()

Convenience method to return this cast to a type. For use in D with statements.

getDObject
T getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.