mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-24 14:36:13 +01:00
docs: Move the GSeekable SECTION
Move it to the struct docs. Signed-off-by: Philip Withnall <philip@tecnocode.co.uk> Helps: #3037
This commit is contained in:
parent
bea92c4882
commit
0d39a138c7
@ -26,25 +26,22 @@
|
||||
|
||||
|
||||
/**
|
||||
* SECTION:gseekable
|
||||
* @short_description: Stream seeking interface
|
||||
* @include: gio/gio.h
|
||||
* @see_also: #GInputStream, #GOutputStream
|
||||
* GSeekable:
|
||||
*
|
||||
* #GSeekable is implemented by streams (implementations of
|
||||
* #GInputStream or #GOutputStream) that support seeking.
|
||||
* `GSeekable` is implemented by streams (implementations of
|
||||
* [class@Gio.InputStream] or [class@Gio.OutputStream]) that support seeking.
|
||||
*
|
||||
* Seekable streams largely fall into two categories: resizable and
|
||||
* fixed-size.
|
||||
*
|
||||
* #GSeekable on fixed-sized streams is approximately the same as POSIX
|
||||
* lseek() on a block device (for example: attempting to seek past the
|
||||
* end of the device is an error). Fixed streams typically cannot be
|
||||
* `GSeekable` on fixed-sized streams is approximately the same as POSIX
|
||||
* [`lseek()`](man:lseek(2)) on a block device (for example: attempting to seek
|
||||
* past the end of the device is an error). Fixed streams typically cannot be
|
||||
* truncated.
|
||||
*
|
||||
* #GSeekable on resizable streams is approximately the same as POSIX
|
||||
* lseek() on a normal file. Seeking past the end and writing data will
|
||||
* usually cause the stream to resize by introducing zero bytes.
|
||||
* `GSeekable` on resizable streams is approximately the same as POSIX
|
||||
* [`lseek()`](man:lseek(2)) on a normal file. Seeking past the end and writing
|
||||
* data will usually cause the stream to resize by introducing zero bytes.
|
||||
**/
|
||||
|
||||
typedef GSeekableIface GSeekableInterface;
|
||||
|
@ -36,11 +36,6 @@ G_BEGIN_DECLS
|
||||
#define G_IS_SEEKABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SEEKABLE))
|
||||
#define G_SEEKABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SEEKABLE, GSeekableIface))
|
||||
|
||||
/**
|
||||
* GSeekable:
|
||||
*
|
||||
* Seek object for streaming operations.
|
||||
**/
|
||||
typedef struct _GSeekableIface GSeekableIface;
|
||||
|
||||
/**
|
||||
|
Loading…
Reference in New Issue
Block a user