glibmm: Gio::MemoryOutputStream Class Reference
Streaming output operations on memory chunks. More...
#include <giomm/memoryoutputstream.h>

Public Member Functions |
|
MemoryOutputStream ( MemoryOutputStream && src) noexcept | |
MemoryOutputStream & | operator= ( MemoryOutputStream && src) noexcept |
~MemoryOutputStream () noexceptoverride | |
GMemoryOutputStream* | gobj () |
Provides access to the underlying C GObject.
More...
|
|
const GMemoryOutputStream* | gobj () const |
Provides access to the underlying C GObject.
More...
|
|
GMemoryOutputStream* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
More...
|
|
void* | get_data () |
Gets any loaded data from the
ostream
.
More...
|
|
const void* | get_data () const |
Gets any loaded data from the
ostream
.
More...
|
|
void* | steal_data () |
Gets any loaded data from the
ostream
.
More...
|
|
gsize | get_size () const |
Gets the size of the currently allocated data area (available from g_memory_output_stream_get_data()).
More...
|
|
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.
More...
|
|
Glib::RefPtr < Glib::Bytes > | steal_as_bytes () |
Returns data from the
ostream
as a Bytes.
More...
|
|
Glib::PropertyProxy_ReadOnly < void* > | property_data () const |
Pointer to buffer where data will be written.
More...
|
|
Glib::PropertyProxy_ReadOnly < gulong > | property_data_size () const |
Size of data written to the buffer.
More...
|
|
Glib::PropertyProxy_ReadOnly < gulong > | property_size () const |
Current size of the data buffer.
More...
|
|
![]() |
|
OutputStream ( OutputStream && src) noexcept | |
OutputStream & | operator= ( OutputStream && src) noexcept |
~OutputStream () noexceptoverride | |
GOutputStream* | gobj () |
Provides access to the underlying C GObject.
More...
|
|
const GOutputStream* | gobj () const |
Provides access to the underlying C GObject.
More...
|
|
GOutputStream* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
More...
|
|
gssize | write (const void* buffer, gsize count , const Glib::RefPtr < Cancellable >& cancellable) |
Tries to write
count
bytes from
buffer
into the stream.
More...
|
|
gssize | write (const void* buffer, gsize count ) |
A
write()
convenience overload.
More...
|
|
gssize | write (const std::string & buffer, const Glib::RefPtr < Cancellable >& cancellable) |
Tries to write
count
bytes from
buffer
into the stream.
More...
|
|
gssize | write (const std::string & buffer) |
Tries to write
count
bytes from
buffer
into the stream.
More...
|
|
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.
More...
|
|
bool | write_all (const void* buffer, gsize count , gsize& bytes_written) |
A
write_all()
convenience overload.
More...
|
|
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.
More...
|
|
bool | write_all (const std::string & buffer, gsize& bytes_written) |
Tries to write
count
bytes from
buffer
into the stream.
More...
|
|
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.
More...
|
|
gssize | write_bytes (const Glib::RefPtr < const Glib::Bytes >& bytes) |
A
write_bytes()
convenience overload.
More...
|
|
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.
More...
|
|
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.
More...
|
|
gssize | write_bytes_finish (const Glib::RefPtr < AsyncResult >& result) |
Finishes a stream write-from-Bytes operation.
More...
|
|
gssize | splice (const Glib::RefPtr < InputStream >& source, const Glib::RefPtr < Cancellable >& cancellable, OutputStreamSpliceFlags flags= OUTPUT_STREAM_SPLICE_NONE ) |
Splices an input stream into an output stream.
More...
|
|
gssize | splice (const Glib::RefPtr < InputStream >& source, OutputStreamSpliceFlags flags= OUTPUT_STREAM_SPLICE_NONE ) |
Splices an input stream into an output stream.
More...
|
|
bool | flush (const Glib::RefPtr < Cancellable >& cancellable) |
Flushed any outstanding buffers in the stream.
More...
|
|
bool | flush () |
A
flush()
convenience overload.
More...
|
|
bool | close (const Glib::RefPtr < Cancellable >& cancellable) |
Closes the stream, releasing resources related to it.
More...
|
|
bool | close () |
A
close()
convenience overload.
More...
|
|
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.
More...
|
|
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.
More...
|
|
gssize | write_finish (const Glib::RefPtr < AsyncResult >& result) |
Finishes a stream write operation.
More...
|
|
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.
More...
|
|
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.
More...
|
|
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().
More...
|
|
void | splice_async (const Glib::RefPtr < InputStream >& source, const SlotAsyncReady & slot, const Glib::RefPtr < Cancellable >& cancellable, OutputStreamSpliceFlags flags= OUTPUT_STREAM_SPLICE_NONE , int io_priority= Glib::PRIORITY_DEFAULT ) |
Splices a stream asynchronously.
More...
|
|
void | splice_async (const Glib::RefPtr < InputStream >& source, const SlotAsyncReady & slot, OutputStreamSpliceFlags flags= OUTPUT_STREAM_SPLICE_NONE , int io_priority= Glib::PRIORITY_DEFAULT ) |
Splices a stream asynchronously.
More...
|
|
gssize | splice_finish (const Glib::RefPtr < AsyncResult >& result) |
Finishes an asynchronous stream splice operation.
More...
|
|
void | flush_async (const SlotAsyncReady & slot, const Glib::RefPtr < Cancellable >& cancellable, int io_priority= Glib::PRIORITY_DEFAULT ) |
Flushes a stream asynchronously.
More...
|
|
void | flush_async (const SlotAsyncReady & slot, int io_priority= Glib::PRIORITY_DEFAULT ) |
Flushes a stream asynchronously.
More...
|
|
bool | flush_finish (const Glib::RefPtr < AsyncResult >& result) |
Finishes flushing an output stream.
More...
|
|
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.
More...
|
|
void | close_async (const SlotAsyncReady & slot, int io_priority= Glib::PRIORITY_DEFAULT ) |
Requests an asynchronous close of the stream, releasing resources related to it.
More...
|
|
bool | close_finish (const Glib::RefPtr < AsyncResult >& result) |
Closes an output stream.
More...
|
|
![]() |
|
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 (const Quark & key, void* data, DestroyNotify notify) |
void | remove_data (const QueryQuark & quark) |
void* | steal_data (const QueryQuark & quark) |
![]() |
|
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.
More...
|
|
void | get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const |
You probably want to use a specific property_*() accessor method instead.
More...
|
|
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.
More...
|
|
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.
More...
|
|
void | 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.
More...
|
|
void | connect_property_changed (const Glib::ustring & property_name, sigc::slot < void >&& slot) |
You can use the signal_changed() signal of the property proxy instead.
More...
|
|
sigc::connection | connect_property_changed_with_return (const Glib::ustring & property_name, const sigc::slot < void >& slot) |
You can use the signal_changed() signal of the property proxy instead.
More...
|
|
sigc::connection | connect_property_changed_with_return (const Glib::ustring & property_name, sigc::slot < void >&& slot) |
You can use the signal_changed() signal of the property proxy instead.
More...
|
|
void | freeze_notify () |
Increases the freeze count on object.
More...
|
|
void | thaw_notify () |
Reverts the effect of a previous call to
freeze_notify()
.
More...
|
|
virtual void | reference () const |
Increment the reference count for this object.
More...
|
|
virtual void | unreference () const |
Decrement the reference count for this object.
More...
|
|
GObject* | gobj () |
Provides access to the underlying C GObject.
More...
|
|
const GObject* | gobj () const |
Provides access to the underlying C GObject.
More...
|
|
GObject* | gobj_copy () const |
Give a ref-ed copy to someone. Use for direct struct access.
More...
|
|
![]() |
|
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable ( trackable &&src) | |
~trackable () | |
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= ( trackable &&src) |
void | remove_destroy_notify_callback (void *data) const |
![]() |
|
Seekable ( Seekable && src) noexcept | |
Seekable & | operator= ( Seekable && src) noexcept |
~Seekable () noexceptoverride | |
GSeekable* | gobj () |
Provides access to the underlying C GObject.
More...
|
|
const GSeekable* | gobj () const |
Provides access to the underlying C GObject.
More...
|
|
goffset | tell () const |
Tells the current position within the stream.
More...
|
|
bool | can_seek () const |
Tests if the stream supports the SeekableIface.
More...
|
|
bool | seek (goffset offset, Glib::SeekType type, const Glib::RefPtr < Cancellable >& cancellable) |
Seeks in the stream by the given
offset
, modified by
type
.
More...
|
|
bool | seek (goffset offset, Glib::SeekType type) |
A
seek()
convenience overload.
More...
|
|
bool | can_truncate () const |
Tests if the stream can be truncated.
More...
|
|
bool | truncate (goffset offset, const Glib::RefPtr < Cancellable >& cancellable) |
Truncates a stream with a given #offset.
More...
|
|
bool | truncate (goffset offset) |
A
truncate()
convenience overload.
More...
|
|
![]() |
|
Interface () | |
A Default constructor.
More...
|
|
Interface ( Interface && src) noexcept | |
Interface & | operator= ( Interface && src) noexcept |
Interface (const Glib::Interface_Class& interface_class) | |
Called by constructors of derived classes.
More...
|
|
Interface (GObject* castitem) | |
Called by constructors of derived classes.
More...
|
|
~Interface () noexceptoverride | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject* | gobj () |
const GObject* | gobj () const |
Static Public Member Functions |
|
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system.
More...
|
|
static Glib::RefPtr < MemoryOutputStream > | create (void* data, gsize size , GReallocFunc realloc_function, GDestroyNotify destroy_function) |
![]() |
|
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system.
More...
|
|
![]() |
|
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.
More...
|
|
Protected Member Functions |
|
MemoryOutputStream (void* data, gsize size , GReallocFunc realloc_function, GDestroyNotify destroy_function) | |
![]() |
|
Object () | |
Object (const Glib::ConstructParams& construct_params) | |
Object (GObject* castitem) | |
~Object () noexceptoverride | |
![]() |
|
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.
More...
|
|
ObjectBase (const char* custom_type_name) | |
A derived constructor always overrides this choice.
More...
|
|
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.
More...
|
|
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) |
![]() |
|
Seekable () | |
You should derive from this class to use it.
More...
|
|
Related Functions |
|
(Note that these are not member functions.) |
|
Glib::RefPtr < Gio::MemoryOutputStream > | wrap (GMemoryOutputStream* object, bool take_copy=false) |
A
Glib::wrap()
method for this object.
More...
|
|
![]() |
|
Glib::RefPtr < Gio::OutputStream > | wrap (GOutputStream* object, bool take_copy=false) |
A
Glib::wrap()
method for this object.
More...
|
|
![]() |
|
Glib::RefPtr < Glib::Object > | wrap (GObject* object, bool take_copy=false) |
![]() |
|
Glib::RefPtr < Gio::Seekable > | wrap (GSeekable* object, bool take_copy=false) |
A
Glib::wrap()
method for this object.
More...
|
|
Additional Inherited Members |
|
![]() |
|
using | DestroyNotify = void(*)(gpointer data) |
![]() |
|
typedef internal::func_destroy_notify | func_destroy_notify |
Detailed Description
Streaming output operations on memory chunks.
This class uses arbitrary memory chunks as output for GIO streaming output operations.
Constructor & Destructor Documentation
|
noexcept |
|
override noexcept |
|
explicit protected |
Member Function Documentation
|
static |
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.
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.
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.
- Returns
- The number of bytes written to the stream.
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 IO_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.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
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.
|
noexcept |
Glib::PropertyProxy_ReadOnly < void* > Gio::MemoryOutputStream::property_data | ( | ) | const |
Pointer to buffer where data will be written.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly < gulong > Gio::MemoryOutputStream::property_data_size | ( | ) | const |
Size of data written to the buffer.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly < gulong > Gio::MemoryOutputStream::property_size | ( | ) | const |
Current size of the data buffer.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
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.
- Returns
- The stream's 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.
- Returns
-
The stream's data, or
nullptr
if it has previously been stolen.
Friends And Related Function Documentation
|
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.