Gio::MemoryOutputStream Class Reference

Streaming output operations on memory chunks. More...

#include <giomm/memoryoutputstream.h>

Inheritance diagram for Gio::MemoryOutputStream:

Public Member Functions
	MemoryOutputStream (MemoryOutputStream &&src) noexcept
MemoryOutputStream &	operator= (MemoryOutputStream &&src) noexcept
	~MemoryOutputStream () noexcept override
GMemoryOutputStream *	gobj ()
	Provides access to the underlying C GObject.
const GMemoryOutputStream *	gobj () const
	Provides access to the underlying C GObject.
GMemoryOutputStream *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void *	get_data ()
	Gets any loaded data from the ostream.
const void *	get_data () const
	Gets any loaded data from the ostream.
void *	steal_data ()
	Gets any loaded data from the ostream.
gsize	get_size () const
	Gets the size of the currently allocated data area (available from g_memory_output_stream_get_data()).
gsize	get_data_size () const
	Returns the number of bytes from the start up to including the last byte written in the stream that has not been truncated away.
Glib::RefPtr< Glib::Bytes >	steal_as_bytes ()
	Returns data from the ostream as a Bytes.
Glib::PropertyProxy_ReadOnly< void * >	property_data () const
	Pointer to buffer where data will be written.
Glib::PropertyProxy_ReadOnly< gulong >	property_data_size () const
	Size of data written to the buffer.
Glib::PropertyProxy_ReadOnly< gulong >	property_size () const
	Current size of the data buffer.
Public Member Functions inherited from Gio::OutputStream
	OutputStream (OutputStream &&src) noexcept
OutputStream &	operator= (OutputStream &&src) noexcept
	~OutputStream () noexcept override
GOutputStream *	gobj ()
	Provides access to the underlying C GObject.
const GOutputStream *	gobj () const
	Provides access to the underlying C GObject.
GOutputStream *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
gssize	write (const void *buffer, gsize count, const Glib::RefPtr< Cancellable > &cancellable)
	Tries to write count bytes from buffer into the stream.
gssize	write (const void *buffer, gsize count)
	A write() convenience overload.
gssize	write (const std::string &buffer, const Glib::RefPtr< Cancellable > &cancellable)
	Tries to write count bytes from buffer into the stream.
gssize	write (const std::string &buffer)
	Tries to write count bytes from buffer into the stream.
bool	write_all (const void *buffer, gsize count, gsize &bytes_written, const Glib::RefPtr< Cancellable > &cancellable)
	Tries to write count bytes from buffer into the stream.
bool	write_all (const void *buffer, gsize count, gsize &bytes_written)
	A write_all() convenience overload.
bool	write_all (const std::string &buffer, gsize &bytes_written, const Glib::RefPtr< Cancellable > &cancellable)
	Tries to write count bytes from buffer into the stream.
bool	write_all (const std::string &buffer, gsize &bytes_written)
	Tries to write count bytes from buffer into the stream.
gssize	write_bytes (const Glib::RefPtr< const Glib::Bytes > & bytes, const Glib::RefPtr< Cancellable > &cancellable)
	A wrapper function for g_output_stream_write() which takes a Bytes as input.
gssize	write_bytes (const Glib::RefPtr< const Glib::Bytes > & bytes)
	A write_bytes() convenience overload.
void	write_bytes_async (const Glib::RefPtr< const Glib::Bytes > & bytes, const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
	Request an asynchronous write of the data in bytes to the stream.
void	write_bytes_async (const Glib::RefPtr< const Glib::Bytes > & bytes, const SlotAsyncReady &slot, int io_priority=Glib::PRIORITY_DEFAULT)
	Request an asynchronous write of the data in bytes to the stream.
gssize	write_bytes_finish (const Glib::RefPtr< AsyncResult > &result)
	Finishes a stream write-from-Bytes operation.
gssize	splice (const Glib::RefPtr< InputStream > &source, const Glib::RefPtr< Cancellable > &cancellable, SpliceFlags flags=SpliceFlags::NONE)
	Splices an input stream into an output stream.
gssize	splice (const Glib::RefPtr< InputStream > &source, SpliceFlags flags=SpliceFlags::NONE)
	Splices an input stream into an output stream.
bool	flush (const Glib::RefPtr< Cancellable > &cancellable)
	Flushed any outstanding buffers in the stream.
bool	flush ()
	A flush() convenience overload.
bool	close (const Glib::RefPtr< Cancellable > &cancellable)
	Closes the stream, releasing resources related to it.
bool	close ()
	A close() convenience overload.
void	write_async (const void *buffer, gsize count, const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
	Request an asynchronous write of count bytes from buffer into the stream.
void	write_async (const void *buffer, gsize count, const SlotAsyncReady &slot, int io_priority=Glib::PRIORITY_DEFAULT)
	Request an asynchronous write of count bytes from buffer into the stream.
gssize	write_finish (const Glib::RefPtr< AsyncResult > &result)
	Finishes a stream write operation.
void	write_all_async (const void *buffer, gsize count, const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
	Request an asynchronous write of count bytes from buffer into the stream.
void	write_all_async (const void *buffer, gsize count, const SlotAsyncReady &slot, int io_priority=Glib::PRIORITY_DEFAULT)
	Request an asynchronous write of count bytes from buffer into the stream.
bool	write_all_finish (const Glib::RefPtr< AsyncResult > &result, gsize &bytes_written)
	Finishes an asynchronous stream write operation started with g_output_stream_write_all_async().
void	splice_async (const Glib::RefPtr< InputStream > &source, const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, SpliceFlags flags=SpliceFlags::NONE, int io_priority=Glib::PRIORITY_DEFAULT)
	Splices a stream asynchronously.
void	splice_async (const Glib::RefPtr< InputStream > &source, const SlotAsyncReady &slot, SpliceFlags flags=SpliceFlags::NONE, int io_priority=Glib::PRIORITY_DEFAULT)
	Splices a stream asynchronously.
gssize	splice_finish (const Glib::RefPtr< AsyncResult > &result)
	Finishes an asynchronous stream splice operation.
void	flush_async (const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
	Flushes a stream asynchronously.
void	flush_async (const SlotAsyncReady &slot, int io_priority=Glib::PRIORITY_DEFAULT)
	Flushes a stream asynchronously.
bool	flush_finish (const Glib::RefPtr< AsyncResult > &result)
	Finishes flushing an output stream.
void	close_async (const SlotAsyncReady &slot, const Glib::RefPtr< Cancellable > &cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
	Requests an asynchronous close of the stream, releasing resources related to it.
void	close_async (const SlotAsyncReady &slot, int io_priority=Glib::PRIORITY_DEFAULT)
	Requests an asynchronous close of the stream, releasing resources related to it.
bool	close_finish (const Glib::RefPtr< AsyncResult > &result)
	Closes an output stream.
bool	is_closed () const
	Checks if an output stream has already been closed.
bool	is_closing () const
	Checks if an output stream is being closed.
bool	has_pending () const
	Checks if an output stream has pending actions.
Public Member Functions inherited from Glib::Object
	Object (const Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&src) noexcept
Object &	operator= (Object &&src) noexcept
void *	get_data (const QueryQuark & key)
void	set_data (const Quark & key, void *data)
void	set_data_with_c_callback (const Quark & key, void *data, GDestroyNotify notify)
void	set_data (const Quark & key, void *data, DestroyNotify notify)
	Prefer set_data_with_c_callback() with a callback with C linkage.
void	remove_data (const QueryQuark &quark)
void *	steal_data (const QueryQuark &quark)
Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete
ObjectBase &	operator= (const ObjectBase &)=delete
void	set_property_value (const Glib::ustring & property_name, const Glib::ValueBase & value)
	You probably want to use a specific property_*() accessor method instead.
void	get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const
	You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
void	set_property (const Glib::ustring & property_name, const PropertyType & value)
	You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
void	get_property (const Glib::ustring & property_name, PropertyType & value) const
	You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
PropertyType	get_property (const Glib::ustring & property_name) const
	You probably want to use a specific property_*() accessor method instead.
sigc::connection	connect_property_changed (const Glib::ustring & property_name, const sigc::slot< void()> &slot)
	You can use the signal_changed() signal of the property proxy instead.
sigc::connection	connect_property_changed (const Glib::ustring & property_name, sigc::slot< void()> &&slot)
	You can use the signal_changed() signal of the property proxy instead.
void	freeze_notify ()
	Increases the freeze count on object.
void	thaw_notify ()
	Reverts the effect of a previous call to freeze_notify().
virtual void	reference () const
	Increment the reference count for this object.
virtual void	unreference () const
	Decrement the reference count for this object.
GObject *	gobj ()
	Provides access to the underlying C GObject.
const GObject *	gobj () const
	Provides access to the underlying C GObject.
GObject *	gobj_copy () const
	Give a ref-ed copy to someone. Use for direct struct access.
Public Member Functions inherited from Gio::Seekable
	Seekable (Seekable &&src) noexcept
Seekable &	operator= (Seekable &&src) noexcept
	~Seekable () noexcept override
GSeekable *	gobj ()
	Provides access to the underlying C GObject.
const GSeekable *	gobj () const
	Provides access to the underlying C GObject.
goffset	tell () const
	Tells the current position within the stream.
bool	can_seek () const
	Tests if the stream supports the SeekableIface.
bool	seek (goffset offset, Glib::SeekType type, const Glib::RefPtr< Cancellable > &cancellable)
	Seeks in the stream by the given offset, modified by type.
bool	seek (goffset offset, Glib::SeekType type)
	A seek() convenience overload.
bool	can_truncate () const
	Tests if the length of the stream can be adjusted with g_seekable_truncate().
bool	truncate (goffset offset, const Glib::RefPtr< Cancellable > &cancellable)
	Truncates a stream with a given offset.
bool	truncate (goffset offset)
	A truncate() convenience overload.
Public Member Functions inherited from Glib::Interface
	Interface ()
	A Default constructor.
	Interface (Interface &&src) noexcept
Interface &	operator= (Interface &&src) noexcept
	Interface (const Glib::Interface_Class &interface_class)
	Called by constructors of derived classes.
	Interface (GObject *castitem)
	Called by constructors of derived classes.
	~Interface () noexcept override
	Interface (const Interface &)=delete
Interface &	operator= (const Interface &)=delete
GObject *	gobj ()
const GObject *	gobj () const
Public Member Functions inherited from Gio::PollableOutputStream
	PollableOutputStream (PollableOutputStream &&src) noexcept
PollableOutputStream &	operator= (PollableOutputStream &&src) noexcept
	~PollableOutputStream () noexcept override
GPollableOutputStream *	gobj ()
	Provides access to the underlying C GObject.
const GPollableOutputStream *	gobj () const
	Provides access to the underlying C GObject.
bool	can_poll () const
	Checks if stream is actually pollable.
bool	is_writable () const
	Checks if stream can be written.
gssize	write_nonblocking (const void *buffer, gsize count, const Glib::RefPtr< Cancellable > &cancellable)
	Attempts to write up to count bytes from buffer to stream, as with g_output_stream_write().
gssize	write_nonblocking (const void *buffer, gsize count)
	A write_nonblocking() convenience overload.

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
static Glib::RefPtr< MemoryOutputStream >	create ()
static Glib::RefPtr< MemoryOutputStream >	create (void *data, gsize size, GReallocFunc realloc_function, GDestroyNotify destroy_function)
Static Public Member Functions inherited from Gio::OutputStream
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
Static Public Member Functions inherited from Gio::Seekable
static void	add_interface (GType gtype_implementer)
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
Static Public Member Functions inherited from Gio::PollableOutputStream
static void	add_interface (GType gtype_implementer)
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

Protected Member Functions
	MemoryOutputStream ()
	Creates a resizable stream.
	MemoryOutputStream (void *data, gsize size, GReallocFunc realloc_function, GDestroyNotify destroy_function)
Protected Member Functions inherited from Gio::OutputStream
	OutputStream ()
bool	set_pending ()
	Sets stream to have actions pending.
void	clear_pending ()
	Clears the pending flag on stream.
virtual gssize	write_vfunc (const void *buffer, gsize count, const Glib::RefPtr< Cancellable > &cancellable)
virtual gssize	splice_vfunc (const Glib::RefPtr< InputStream > &source, const Glib::RefPtr< Cancellable > &cancellable, SpliceFlags flags)
virtual bool	flush_vfunc (const Glib::RefPtr< Cancellable > &cancellable)
virtual bool	close_vfunc (const Glib::RefPtr< Cancellable > &cancellable)
Protected Member Functions inherited from Glib::Object
	Object ()
	Object (const Glib::ConstructParams &construct_params)
	Object (GObject *castitem)
	~Object () noexcept override
Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()
	This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor.
	ObjectBase (const char *custom_type_name)
	A derived constructor always overrides this choice.
	ObjectBase (const std::type_info &custom_type_info)
	This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually.
	ObjectBase (ObjectBase &&src) noexcept
ObjectBase &	operator= (ObjectBase &&src) noexcept
virtual	~ObjectBase () noexcept=0
void	initialize (GObject *castitem)
void	initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
Protected Member Functions inherited from Gio::Seekable
	Seekable ()
	You should derive from this class to use it.
Protected Member Functions inherited from Gio::PollableOutputStream
	PollableOutputStream ()
	You should derive from this class to use it.
virtual bool	can_poll_vfunc () const
virtual bool	is_writable_vfunc () const
virtual gssize	write_nonblocking_vfunc (const void *buffer, gsize count)

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gio::MemoryOutputStream >	wrap (GMemoryOutputStream *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gio::OutputStream
Glib::RefPtr< Gio::OutputStream >	wrap (GOutputStream *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Glib::Object
Glib::RefPtr< Glib::Object >	wrap (GObject *object, bool take_copy=false)
Related Symbols inherited from Gio::Seekable
Glib::RefPtr< Gio::Seekable >	wrap (GSeekable *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gio::PollableOutputStream
Glib::RefPtr< Gio::PollableOutputStream >	wrap (GPollableOutputStream *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Additional Inherited Members
Public Types inherited from Gio::OutputStream
enum class	SpliceFlags {   NONE = 0x0 ,   CLOSE_SOURCE = (1 << 0) ,   CLOSE_TARGET = (1 << 1) }
Public Types inherited from Glib::Object
using	DestroyNotify = void(*)(gpointer data)

Detailed Description

Streaming output operations on memory chunks.

This class uses arbitrary memory chunks as output for GIO streaming output operations.

Since glibmm 2.20:

Constructor & Destructor Documentation

MemoryOutputStream() [1/3]

Gio::MemoryOutputStream::MemoryOutputStream ( MemoryOutputStream &&  src )

noexcept

~MemoryOutputStream()

Gio::MemoryOutputStream::~MemoryOutputStream ( )

overridenoexcept

MemoryOutputStream() [2/3]

Gio::MemoryOutputStream::MemoryOutputStream ( )

protected

Creates a resizable stream.

MemoryOutputStream() [3/3]

Gio::MemoryOutputStream::MemoryOutputStream ( void *  data, gsize  size, GReallocFunc  realloc_function, GDestroyNotify  destroy_function  )

explicitprotected

Member Function Documentation

create() [1/2]

static Glib::RefPtr< MemoryOutputStream > Gio::MemoryOutputStream::create ( )

static

create() [2/2]

static Glib::RefPtr< MemoryOutputStream > Gio::MemoryOutputStream::create ( void *  data, gsize  size, GReallocFunc  realloc_function, GDestroyNotify  destroy_function  )

static

get_data() [1/2]

void * Gio::MemoryOutputStream::get_data

(

)

Gets any loaded data from the ostream.

Note that the returned pointer may become invalid on the next write or truncate operation on the stream.

Returns

Pointer to the stream's data, or nullptr if the data has been stolen.

get_data() [2/2]

const void * Gio::MemoryOutputStream::get_data

(

)

const

Gets any loaded data from the ostream.

Note that the returned pointer may become invalid on the next write or truncate operation on the stream.

Returns

Pointer to the stream's data, or nullptr if the data has been stolen.

get_data_size()

gsize Gio::MemoryOutputStream::get_data_size

(

)

const

Returns the number of bytes from the start up to including the last byte written in the stream that has not been truncated away.

Since glibmm 2.18:

Returns

The number of bytes written to the stream.

get_size()

gsize Gio::MemoryOutputStream::get_size

(

)

const

Gets the size of the currently allocated data area (available from g_memory_output_stream_get_data()).

You probably don't want to use this function on resizable streams. See g_memory_output_stream_get_data_size() instead. For resizable streams the size returned by this function is an implementation detail and may be change at any time in response to operations on the stream.

If the stream is fixed-sized (ie: no realloc was passed to g_memory_output_stream_new()) then this is the maximum size of the stream and further writes will return Gio::Error::NO_SPACE.

In any case, if you want the number of bytes currently written to the stream, use g_memory_output_stream_get_data_size().

Returns

The number of bytes allocated for the data buffer.

get_type()

static GType Gio::MemoryOutputStream::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

gobj() [1/2]

GMemoryOutputStream * Gio::MemoryOutputStream::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

const GMemoryOutputStream * Gio::MemoryOutputStream::gobj ( ) const

inline

Provides access to the underlying C GObject.

gobj_copy()

GMemoryOutputStream * Gio::MemoryOutputStream::gobj_copy

(

)

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

operator=()

MemoryOutputStream & Gio::MemoryOutputStream::operator= ( MemoryOutputStream &&  src )

noexcept

property_data()

Glib::PropertyProxy_ReadOnly< void * > Gio::MemoryOutputStream::property_data

(

)

const

Pointer to buffer where data will be written.

Since glibmm 2.24:

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_data_size()

Glib::PropertyProxy_ReadOnly< gulong > Gio::MemoryOutputStream::property_data_size

(

)

const

Size of data written to the buffer.

Since glibmm 2.24:

Default value: 0

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

property_size()

Glib::PropertyProxy_ReadOnly< gulong > Gio::MemoryOutputStream::property_size

(

)

const

Current size of the data buffer.

Since glibmm 2.24:

Default value: 0

Returns

A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

steal_as_bytes()

Glib::RefPtr< Glib::Bytes > Gio::MemoryOutputStream::steal_as_bytes

(

)

Returns data from the ostream as a Bytes.

ostream must be closed before calling this function.

Since glibmm 2.34:

Returns

The stream's data.

steal_data()

void * Gio::MemoryOutputStream::steal_data

(

)

Gets any loaded data from the ostream.

Ownership of the data is transferred to the caller; when no longer needed it must be freed using the free function set in ostream's MemoryOutputStream::property_destroy_function() property.

ostream must be closed before calling this function.

Since glibmm 2.26:

Returns

The stream's data, or nullptr if it has previously been stolen.

Friends And Related Symbol Documentation

wrap()

Glib::RefPtr< Gio::MemoryOutputStream > wrap ( GMemoryOutputStream *  object, bool  take_copy = false  )

related

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns

A C++ instance that wraps this C instance.