glibmm: Gio::FileInputStream Class Reference
FileInputStream provides input streams that take their content from a file. More...
#include <giomm/fileinputstream.h>
Public Member Functions | |
virtual | ~FileInputStream () |
GFileInputStream* | gobj () |
Provides access to the underlying C GObject. More... | |
const GFileInputStream* | gobj () const |
Provides access to the underlying C GObject. More... | |
GFileInputStream* | 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< FileInfo > | query_info (const Glib::RefPtr< Cancellable >& cancellable, const std::string& attributes="*") |
Queries a file input stream the given attributes. More... | |
Glib::RefPtr< FileInfo > | query_info (const std::string& attributes="*") |
Queries a file input stream the given attributes. More... | |
void | query_info_async (const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, const std::string& attributes="*", int io_priority=Glib::PRIORITY_DEFAULT) |
Queries the stream information asynchronously. More... | |
void | query_info_async (const SlotAsyncReady& slot, const std::string& attributes="*", int io_priority=Glib::PRIORITY_DEFAULT) |
Queries the stream information asynchronously. More... | |
Glib::RefPtr< FileInfo > | query_info_finish (const Glib::RefPtr< AsyncResult >& result) |
Finishes an asynchronous info query operation. More... | |
Public Member Functions inherited from Gio::InputStream | |
virtual | ~InputStream () |
GInputStream* | gobj () |
Provides access to the underlying C GObject. More... | |
const GInputStream* | gobj () const |
Provides access to the underlying C GObject. More... | |
GInputStream* | 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 | read (void* buffer, gsize count, const Glib::RefPtr< Cancellable >& cancellable) |
Tries to read count bytes from the stream into the buffer starting at buffer. More... | |
gssize | read (void* buffer, gsize count) |
A read() convenience overload. More... | |
bool | read_all (void* buffer, gsize count, gsize& bytes_read, const Glib::RefPtr< Cancellable >& cancellable) |
Tries to read count bytes from the stream into the buffer starting at buffer. More... | |
bool | read_all (void* buffer, gsize count, gsize& bytes_read) |
A read_all() convenience overload. More... | |
Glib::RefPtr< Glib::Bytes > | read_bytes (gsize count, const Glib::RefPtr< Cancellable >& cancellable) |
Like g_input_stream_read(), this tries to read count bytes from the stream in a blocking fashion. More... | |
void | read_bytes_async (gsize count, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT) |
Request an asynchronous read of count bytes from the stream into a new Glib::Bytes. More... | |
void | read_bytes_async (gsize count, const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT) |
Request an asynchronous read of count bytes from the stream into a new Glib::Bytes. More... | |
Glib::RefPtr< Glib::Bytes > | read_bytes_finish (const Glib::RefPtr< AsyncResult >& result) |
Finishes an asynchronous stream read-into-Bytes operation. More... | |
gssize | skip (gsize count, const Glib::RefPtr< Cancellable >& cancellable) |
Tries to skip count bytes from the stream. More... | |
gssize | skip (gsize count) |
A skip() 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 | read_async (void* buffer, gsize count, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT) |
Request an asynchronous read of count bytes from the stream into the buffer starting at buffer. More... | |
void | read_async (void* buffer, gsize count, const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT) |
Request an asynchronous read of count bytes from the stream into the buffer starting at buffer. More... | |
gssize | read_finish (const Glib::RefPtr< AsyncResult >& result) |
Finishes an asynchronous stream read operation. More... | |
void | skip_async (gsize count, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT) |
Request an asynchronous skip of count bytes from the stream into the buffer starting at buffer. More... | |
void | skip_async (gsize count, const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT) |
Request an asynchronous skip of count bytes from the stream into the buffer starting at buffer. More... | |
gssize | skip_finish (const Glib::RefPtr< AsyncResult >& result) |
Finishes a stream skip operation. More... | |
void | close_async (const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT) |
Requests an asynchronous closes of the stream, releasing resources related to it. More... | |
void | close_async (const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT) |
Requests an asynchronous closes of the stream, releasing resources related to it. More... | |
gboolean | close_finish (const Glib::RefPtr< AsyncResult >& result) |
Finishes closing a stream asynchronously, started from g_input_stream_close_async(). More... | |
Public Member Functions inherited from Glib::Object | |
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) |
Public Member Functions inherited from Glib::ObjectBase | |
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, but this is necessary when using the reduced API. 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, but this is necessary when using the reduced API. 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::Seekable | |
virtual | ~Seekable () |
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... | |
Public Member Functions inherited from Glib::Interface | |
Interface () | |
A Default constructor. More... | |
Interface (const Glib::Interface_Class& interface_class) | |
Called by constructors of derived classes. More... | |
Interface (GObject* castitem) | |
Called by constructors of derived classes. More... | |
virtual | ~Interface () |
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 Public Member Functions inherited from Gio::InputStream | |
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::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. More... | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr < Gio::FileInputStream > | wrap (GFileInputStream* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gio::InputStream | |
Glib::RefPtr< Gio::InputStream > | wrap (GInputStream* 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::Seekable | |
Glib::RefPtr< Gio::Seekable > | wrap (GSeekable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
Public Types inherited from Glib::Object | |
typedef void(* | DestroyNotify )(gpointer data) |
Protected Member Functions inherited from Glib::Object | |
Object () | |
Object (const Glib::ConstructParams& construct_params) | |
Object (GObject* castitem) | |
virtual | ~Object () |
Protected Member Functions inherited from Gio::Seekable | |
Seekable () | |
You should derive from this class to use it. More... | |
Detailed Description
FileInputStream provides input streams that take their content from a file.
FileInputStream implements Seekable, which allows the input stream to jump to arbitrary positions in the file, provided the file system of the file allows it. Use the methods of the Seekable base class for seeking and positioning.
Constructor & Destructor Documentation
|
virtual |
Member Function Documentation
|
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.
GFileInputStream* Gio::FileInputStream::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::RefPtr<FileInfo> Gio::FileInputStream::query_info | ( | const Glib::RefPtr< Cancellable >& | cancellable, |
const std::string & | attributes = "*" |
||
) |
Queries a file input stream the given attributes.
This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see query_info_async(). While the stream is blocked, the stream will set the pending flag internally, and any other operations on the stream will throw a Gio::Error with PENDING.
- Parameters
-
attributes A file attribute query string. cancellable A Cancellable object.
- Returns
- A FileInfo, or an empty RefPtr on error.
Glib::RefPtr<FileInfo> Gio::FileInputStream::query_info | ( | const std::string & | attributes = "*" ) |
Queries a file input stream the given attributes.
This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see query_info_async(). While the stream is blocked, the stream will set the pending flag internally, and any other operations on the stream will throw a Gio::Error with PENDING.
- Parameters
-
attributes A file attribute query string.
- Returns
- A FileInfo, or an empty RefPtr on error.
void Gio::FileInputStream::query_info_async | ( | const SlotAsyncReady& | slot, |
const Glib::RefPtr< Cancellable >& | cancellable, | ||
const std::string & | attributes = "*" , |
||
int | io_priority = Glib::PRIORITY_DEFAULT |
||
) |
Queries the stream information asynchronously.
For the synchronous version of this function, see query_info().
The operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, a Gio::Error with CANCELLED will be thrown.
When the operation is finished, slot will be called. You can then call query_info_finish() to get the result of the operation.
- Parameters
-
slot A callback slot which will be called when the request is satisfied. cancellable A Cancellable object which can be used to cancel the operation. attributes A file attribute query string. io_priority The I/O priority of the request.
void Gio::FileInputStream::query_info_async | ( | const SlotAsyncReady& | slot, |
const std::string & | attributes = "*" , |
||
int | io_priority = Glib::PRIORITY_DEFAULT |
||
) |
Queries the stream information asynchronously.
For the synchronous version of this function, see query_info().
When the operation is finished, slot will be called. You can then call query_info_finish() to get the result of the operation.
- Parameters
-
slot A callback slot which will be called when the request is satisfied. attributes A file attribute query string. io_priority The I/O priority of the request.
Glib::RefPtr<FileInfo> Gio::FileInputStream::query_info_finish | ( | const Glib::RefPtr< AsyncResult >& | result) |
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.