From 268e1681fd5b46e6412d3a8db84f3f1cb02fdbde Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Sat, 13 Jun 2009 14:44:47 +0200 Subject: Add docs for gio.BufferedOutputStream class --- docs/reference/pygio-bufferedoutputstream.xml | 275 ++++++++++++++++++++++++++ docs/reference/pygio-classes.xml | 1 + 2 files changed, 276 insertions(+) create mode 100644 docs/reference/pygio-bufferedoutputstream.xml (limited to 'docs/reference') diff --git a/docs/reference/pygio-bufferedoutputstream.xml b/docs/reference/pygio-bufferedoutputstream.xml new file mode 100644 index 0000000..6d7900f --- /dev/null +++ b/docs/reference/pygio-bufferedoutputstream.xml @@ -0,0 +1,275 @@ + + + + + + gio.BufferedOutputStream + Buffered Output Stream + + + + Synopsis + + + gio.BufferedOutputStream + gio.FilterOutputStream + + + gio.BufferedOutputStream + base_stream + + + + get_auto_grow + + + + get_buffer_size + + + + set_auto_grow + auto_grow + + + set_buffer_size + size + + + + + +Functions + + + gio.buffered_output_stream_new_sized + size + + + + + + Ancestry + ++-- gobject.GObject + +-- gio.OutputStream + +-- gio.FilterOutputStream + +-- gio.BufferedOutputStream + + + + + + gio.BufferedOutputStream Properties + +
+ + + + + + + + "auto-grow" + Read - Write + Whether the buffer should automatically grow. Default value: False. + + + "buffer-size" + Read - Write - Construct + The size of the backend buffer. Allowed values: >= 1. Default value: 4096. + + + + +
+ + + + + Description + + + gio.BufferedOutputStream + implements gio.FilterOutputStream + and provides for buffered writes. + + + By default, + gio.BufferedOutputStream's + buffer size is set at 4 kilobytes. + + + To create a buffered output stream, use + gio.BufferedOutputStream(), + or gio.buffered_output_stream_new_sized() + to specify the buffer's size at construction. + + + To get the size of a buffer within a buffered output stream, use + gio.BufferedOutputStream.get_buffer_size(). + To change the size of a buffered output stream's buffer, use + gio.BufferedOutputStream.set_buffer_size(). + Note that the buffer's size cannot be reduced below the size of the data within the buffer. + + + + + Constructor + + + gio.BufferedOutputStream + base_stream + + + + base_stream : + a + gio.OutputStream. + + + + Returns : + a new + gio.OutputStream + for the given base_stream. + + + + + + Creates a new buffered output stream for a base stream. + + + + + + Methods + + + gio.BufferedOutputStream.get_auto_grow + + + get_auto_grow + + + + + + Returns : + True if the stream's + buffer automatically grows, False otherwise. + + + + + + The get_auto_grow() method checks if the + buffer automatically grows as data is added. + + + + + gio.BufferedOutputStream.get_buffer_size + + + get_buffer_size + + + + + + Returns : + the current buffer size. + + + + + + The get_buffer_size() method gets the size + of the buffer in the stream. + + + + + gio.BufferedOutputStream.set_auto_grow + + + set_auto_grow + auto_grow + + + + + auto_grow : + a boolean. + + + + + + The set_auto_grow() method sets whether or not + the stream's buffer should automatically grow. If auto_grow is true, + then each write will just make the buffer larger, and you must manually + flush the buffer to actually write out the data to the underlying stream. + + + + + gio.BufferedOutputStream.set_buffer_size + + + set_buffer_size + size + + + + + size : + the new buffer size. + + + + + + The set_buffer_size() method sets the size of + the internal buffer to size. + + + + + + Functions + + + gio.buffered_output_stream_new_sized + + + buffered_output_stream_new_sized + size + + + + + size : + the requested buffer size. + + + + Returns : + A new + gio.OutputStream + with an internal buffer set to size.. + + + + + + The buffered_output_stream_new_sized() function creates + a new gio.BufferedOutputStream + from the given base_stream, with a buffer set to size. + + + + diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml index f9396cb..1c59d61 100644 --- a/docs/reference/pygio-classes.xml +++ b/docs/reference/pygio-classes.xml @@ -11,6 +11,7 @@ + -- cgit