glibmm: Gio::ConverterOutputStream Class Reference

ConverterOutputstream - Converter Output Stream. More...

#include <giomm/converteroutputstream.h>

Inheritance diagram for Gio::ConverterOutputStream:

[legend]

Public Member Functions
	ConverterOutputStream (ConverterOutputStream && src) noexcept

ConverterOutputStream &	operator= (ConverterOutputStream && src) noexcept

	~ConverterOutputStream () noexcept override

GConverterOutputStream *	gobj ()
	Provides access to the underlying C GObject. More...

const GConverterOutputStream *	gobj () const
	Provides access to the underlying C GObject. More...

GConverterOutputStream *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::RefPtr< Converter >	get_converter ()
	Gets the Converter that is used by converter_stream. More...

Glib::RefPtr< const Converter >	get_converter () const
	Gets the Converter that is used by converter_stream. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Converter > >	property_converter () const
	The converter object. More...

Public Member Functions inherited from Gio::FilterOutputStream
	FilterOutputStream (FilterOutputStream && src) noexcept

FilterOutputStream &	operator= (FilterOutputStream && src) noexcept

	~FilterOutputStream () noexcept override

GFilterOutputStream *	gobj ()
	Provides access to the underlying C GObject. More...

const GFilterOutputStream *	gobj () const
	Provides access to the underlying C GObject. More...

GFilterOutputStream *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::RefPtr< OutputStream >	get_base_stream ()
	Gets the base stream for the filter stream. More...

Glib::RefPtr< const OutputStream >	get_base_stream () const
	Gets the base stream for the filter stream. More...

bool	get_close_base_stream () const
	Returns whether the base stream will be closed when stream is closed. More...

void	set_close_base_stream (bool close_base=true)
	Sets whether the base stream will be closed when stream is closed. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< OutputStream > >	property_base_stream () const

Glib::PropertyProxy_ReadOnly< bool >	property_close_base_stream () const
	Whether the base stream should be closed when the filter stream is closed. More...

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. 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, SpliceFlags flags=SpliceFlags::NONE)
	Splices an input stream into an output stream. More...

gssize	splice (const Glib::RefPtr< InputStream > & source, SpliceFlags flags=SpliceFlags::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, SpliceFlags flags=SpliceFlags::NONE, int io_priority=Glib::PRIORITY_DEFAULT)
	Splices a stream asynchronously. More...

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. 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...

bool	is_closed () const
	Checks if an output stream has already been closed. More...

bool	is_closing () const
	Checks if an output stream is being closed. More...

bool	has_pending () const
	Checks if an output stream has pending actions. More...

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. More...

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. 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...

template<class PropertyType >
PropertyType	get_property (const Glib::ustring & property_name) const
	You probably want to use a specific property_*() accessor method instead. More...

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. More...

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. 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...

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. More...

const GPollableOutputStream *	gobj () const
	Provides access to the underlying C GObject. More...

bool	can_poll () const
	Checks if stream is actually pollable. More...

bool	is_writable () const
	Checks if stream can be written. More...

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

gssize	write_nonblocking (const void * buffer, gsize count)
	A write_nonblocking() convenience overload. More...

Public Member Functions inherited from Glib::Interface
	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 () noexcept override

	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< ConverterOutputStream >	create (const Glib::RefPtr< OutputStream > & base_stream, const Glib::RefPtr< Converter > & converter)
	Creates a new converter output stream for the base_stream. More...

Static Public Member Functions inherited from Gio::FilterOutputStream
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

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. More...

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. More...

Protected Member Functions
	ConverterOutputStream (const Glib::RefPtr< OutputStream > & base_stream, const Glib::RefPtr< Converter > & converter)

Protected Member Functions inherited from Gio::FilterOutputStream
	FilterOutputStream (const Glib::RefPtr< OutputStream > & base_stream)

Protected Member Functions inherited from Gio::OutputStream
	OutputStream ()

bool	set_pending ()
	Sets stream to have actions pending. More...

void	clear_pending ()
	Clears the pending flag on stream. More...

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

Protected Member Functions inherited from Gio::PollableOutputStream
	PollableOutputStream ()
	You should derive from this class to use it. More...

virtual bool	can_poll_vfunc () const

virtual bool	is_writable_vfunc () const

virtual gssize	write_nonblocking_vfunc (const void * buffer, gsize count)

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gio::ConverterOutputStream >	wrap (GConverterOutputStream * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gio::FilterOutputStream
Glib::RefPtr< Gio::FilterOutputStream >	wrap (GFilterOutputStream * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gio::OutputStream
Glib::RefPtr< Gio::OutputStream >	wrap (GOutputStream * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Glib::Object
Glib::RefPtr< Glib::Object >	wrap (GObject * object, bool take_copy=false)

Related Functions inherited from Gio::PollableOutputStream
Glib::RefPtr< Gio::PollableOutputStream >	wrap (GPollableOutputStream * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Additional Inherited Members
Public Types inherited from Gio::OutputStream
enum class	SpliceFlags { SpliceFlags::NONE = 0x0 , SpliceFlags::CLOSE_SOURCE = (1 << 0) , SpliceFlags::CLOSE_TARGET = (1 << 1) }
	GOutputStreamSpliceFlags determine how streams should be spliced. More...

Public Types inherited from Glib::Object
using	DestroyNotify = void(*)(gpointer data)

Detailed Description

ConverterOutputstream - Converter Output Stream.

Converter output stream implements OutputStream and allows conversion of data of various types during reading. ConverterOutputStream also implements the PollableOutputStream interface.

Since glibmm 2.34:

Constructor & Destructor Documentation

◆ ConverterOutputStream() [1/2]

Gio::ConverterOutputStream::ConverterOutputStream ( ConverterOutputStream && src )

noexcept

◆ ~ConverterOutputStream()

Gio::ConverterOutputStream::~ConverterOutputStream ( )

overridenoexcept

◆ ConverterOutputStream() [2/2]

Gio::ConverterOutputStream::ConverterOutputStream	(	const Glib::RefPtr< OutputStream > &	base_stream,
		const Glib::RefPtr< Converter > &	converter
	)

explicitprotected

Member Function Documentation

◆ create()

static Glib::RefPtr< ConverterOutputStream > Gio::ConverterOutputStream::create	(	const Glib::RefPtr< OutputStream > &	base_stream,
		const Glib::RefPtr< Converter > &	converter
	)

static

Creates a new converter output stream for the base_stream.

Parameters

base_stream	A OutputStream.
converter	A Converter.

Returns: A new OutputStream.

◆ get_converter() [1/2]

Glib::RefPtr< Converter > Gio::ConverterOutputStream::get_converter ( )

Gets the Converter that is used by converter_stream.

Since glibmm 2.24:

Returns: The converter of the converter output stream.

◆ get_converter() [2/2]

Glib::RefPtr< const Converter > Gio::ConverterOutputStream::get_converter ( ) const

Gets the Converter that is used by converter_stream.

Since glibmm 2.24:

Returns: The converter of the converter output stream.

◆ get_type()

static GType Gio::ConverterOutputStream::get_type ( )

static

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

◆ gobj() [1/2]

GConverterOutputStream * Gio::ConverterOutputStream::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GConverterOutputStream * Gio::ConverterOutputStream::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GConverterOutputStream * Gio::ConverterOutputStream::gobj_copy ( )

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

◆ operator=()

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

noexcept

◆ property_converter()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Converter > > Gio::ConverterOutputStream::property_converter ( ) const

The converter object.

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

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gio::ConverterOutputStream > wrap	(	GConverterOutputStream *	object,
		bool	take_copy = `false`
	)

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