From 3666f75af4ef2c8e038116aee5afada59d59f689 Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Mon, 8 Jun 2009 14:20:02 +0200 Subject: Add docs for gio.MemoryOutputStream --- docs/reference/pygio-classes.xml | 1 + docs/reference/pygio-memoryoutputstream.xml | 175 ++++++++++++++++++++++++++++ 2 files changed, 176 insertions(+) create mode 100644 docs/reference/pygio-memoryoutputstream.xml (limited to 'docs/reference') diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml index 8e5b191..f14c592 100644 --- a/docs/reference/pygio-classes.xml +++ b/docs/reference/pygio-classes.xml @@ -28,6 +28,7 @@ + diff --git a/docs/reference/pygio-memoryoutputstream.xml b/docs/reference/pygio-memoryoutputstream.xml new file mode 100644 index 0000000..f044496 --- /dev/null +++ b/docs/reference/pygio-memoryoutputstream.xml @@ -0,0 +1,175 @@ + + + + + + gio.MemoryOutputStream + Streaming output operations on memory chunks + + + + Synopsis + + + gio.MemoryOutputStream + gio.OutputStream + + + gio.MemoryOutputStream + + + + + + get_contents + + + + get_data_size + + + + get_size + + + + + + + + + Ancestry + ++-- gobject.GObject + +-- gio.OutputStream + +-- gio.MemoryOutputStream + + + + + + Implemented Interfaces + + gio.MemoryOutputStream + implements + gio.Seekable + + + + + Description + + + gio.MemoryOutputStream + is a class for using arbitrary memory chunks as output for GIO streaming output operations. + + + + + Constructor + + + gio.MemoryOutputStream + + + + + Returns : + a new + gio.MemoryOutputStream. + + + + + + Creates a new + gio.MemoryOutputStream. + + + + + + Methods + + + gio.MemoryOutputStream.get_contents + + + get_contents + + + + + + Returns : + the stream's data + + + + + + The get_contents() method gets any loaded data + from the ostream. + + + Note that the returned data may become invalid on the next write or truncate + operation on the stream. + + + + + gio.MemoryOutputStream.get_data_size + + + get_data_size + + + + + + Returns : + the number of bytes written to the stream + + + + + + The get_data_size() method returns the number + of bytes from the start up to including the last byte written in the + stream that has not been truncated away. + + + + + gio.MemoryOutputStream.get_size + + + get_size + + + + + + Returns : + the number of bytes allocated for the data buffer + + + + + + The get_size() method gets the size of the + currently allocated data area (availible from + gio.MemoryOutputStream.get_contents() + ). + + + Note that for growable streams the returned size may become invalid on the next write or truncate operation on the stream. + + + If you want the number of bytes currently written to the stream, use + gio.MemoryOutputStream.get_data_size(). + + + + -- cgit