luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-09-12 21:36:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GFileIOStream SECTION

Browse Source 
Move it to the struct docs.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-14 14:06:59 +00:00
parent 172bb52e3f
commit d00a53416f
2 changed files with 13 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
gio/gfileiostream.c
View File

@ -34,31 +34,28 @@
/**
* SECTION:gfileiostream
* @short_description: File read and write streaming operations
* @include: gio/gio.h
* @see_also: #GIOStream, #GFileInputStream, #GFileOutputStream, #GSeekable
* GFileIOStream:
*
* GFileIOStream provides io streams that both read and write to the same
* `GFileIOStream` provides I/O streams that both read and write to the same
* file handle.
*
* GFileIOStream implements #GSeekable, which allows the io
* `GFileIOStream` implements [iface@Gio.Seekable], which allows the I/O
* stream to jump to arbitrary positions in the file and to truncate
* the file, provided the filesystem of the file supports these
* operations.
*
* To find the position of a file io stream, use
* g_seekable_tell().
* To find the position of a file I/O stream, use [method@Gio.Seekable.tell].
*
* To find out if a file io stream supports seeking, use g_seekable_can_seek().
* To position a file io stream, use g_seekable_seek().
* To find out if a file io stream supports truncating, use
* g_seekable_can_truncate(). To truncate a file io
* stream, use g_seekable_truncate().
* To find out if a file I/O stream supports seeking, use
* [method@Gio.Seekable.can_seek]. To position a file I/O stream, use
* [method@Gio.Seekable.seek]. To find out if a file I/O stream supports
* truncating, use [method@Gio.Seekable.can_truncate]. To truncate a file I/O
* stream, use [method@Gio.Seekable.truncate].
*
* The default implementation of all the `GFileIOStream` operations
* and the implementation of [iface@Gio.Seekable] just call into the same
* operations on the output stream.
*
* The default implementation of all the #GFileIOStream operations
* and the implementation of #GSeekable just call into the same operations
* on the output stream.
* Since: 2.22
**/

8
gio/gfileiostream.h
View File

@ -38,14 +38,6 @@ G_BEGIN_DECLS
#define G_IS_FILE_IO_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_IO_STREAM))
#define G_FILE_IO_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_IO_STREAM, GFileIOStreamClass))
/**
* GFileIOStream:
*
* A subclass of GIOStream for opened files. This adds
* a few file-specific operations and seeking and truncating.
*
* #GFileIOStream implements GSeekable.
**/
typedef struct _GFileIOStreamClass GFileIOStreamClass;
typedef struct _GFileIOStreamPrivate GFileIOStreamPrivate;