@gtkx/ffi 0.1.44 → 0.1.46

package/dist/generated/gio/data-input-stream.js

@@ -1,6 +1,10 @@
 import { call } from "@gtkx/native";
 import { NativeError } from "@gtkx/ffi";
 import { BufferedInputStream } from "./buffered-input-stream.js";
+/**
+ * Data input stream implements [class@Gio.InputStream] and includes functions
+ * for reading structured data directly from a binary input stream.
+ */
 export class DataInputStream extends BufferedInputStream {
     constructor(...args) {
         super(...args);
@@ -14,6 +18,9 @@ export class DataInputStream extends BufferedInputStream {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Gets the byte order for the data input stream.
+     */
     getByteOrder() {
         return call("libgio-2.0.so.0", "g_data_input_stream_get_byte_order", [
             {
@@ -22,6 +29,9 @@ export class DataInputStream extends BufferedInputStream {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the current newline type for the @stream.
+     */
     getNewlineType() {
         return call("libgio-2.0.so.0", "g_data_input_stream_get_newline_type", [
             {
@@ -30,6 +40,13 @@ export class DataInputStream extends BufferedInputStream {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Reads a 16-bit/2-byte value from @stream.
+     *
+     * In order to get the correct byte order for this read operation,
+     * see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     readInt16(cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_input_stream_read_int16", [
@@ -59,6 +76,17 @@ export class DataInputStream extends BufferedInputStream {
         }
         return result;
     }
+    /**
+     * Reads a signed 32-bit/4-byte value from @stream.
+     *
+     * In order to get the correct byte order for this read operation,
+     * see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
+     *
+     * If `cancellable` is not %NULL, then the operation can be cancelled by
+     * triggering the cancellable object from another thread. If the operation
+     * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     readInt32(cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_input_stream_read_int32", [
@@ -88,6 +116,17 @@ export class DataInputStream extends BufferedInputStream {
         }
         return result;
     }
+    /**
+     * Reads a 64-bit/8-byte value from @stream.
+     *
+     * In order to get the correct byte order for this read operation,
+     * see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
+     *
+     * If `cancellable` is not %NULL, then the operation can be cancelled by
+     * triggering the cancellable object from another thread. If the operation
+     * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     readInt64(cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_input_stream_read_int64", [
@@ -117,6 +156,17 @@ export class DataInputStream extends BufferedInputStream {
         }
         return result;
     }
+    /**
+     * Reads a line from the data input stream.  Note that no encoding
+     * checks or conversion is performed; the input is not guaranteed to
+     * be UTF-8, and may in fact have embedded NUL characters.
+     *
+     * If `cancellable` is not %NULL, then the operation can be cancelled by
+     * triggering the cancellable object from another thread. If the operation
+     * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
+     * @param length - a #gsize to get the length of the data read in.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     readLine(length, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_input_stream_read_line", [
@@ -154,6 +204,18 @@ export class DataInputStream extends BufferedInputStream {
         }
         return result;
     }
+    /**
+     * The asynchronous version of g_data_input_stream_read_line().  It is
+     * an error to have two outstanding calls to this function.
+     *
+     * When the operation is finished, `callback` will be called. You
+     * can then call g_data_input_stream_read_line_finish() to get
+     * the result of the operation.
+     * @param ioPriority - the I/O priority of the request
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - callback to call when the request is satisfied.
+     * @param userData - the data to pass to callback function.
+     */
     readLineAsync(ioPriority, cancellable, callback, userData) {
         call("libgio-2.0.so.0", "g_data_input_stream_read_line_async", [
             {
@@ -181,6 +243,14 @@ export class DataInputStream extends BufferedInputStream {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Finish an asynchronous call started by
+     * g_data_input_stream_read_line_async().  Note the warning about
+     * string encoding in g_data_input_stream_read_line() applies here as
+     * well.
+     * @param result - the #GAsyncResult that was provided to the callback.
+     * @param length - a #gsize to get the length of the data read in.
+     */
     readLineFinish(result, length) {
         const error = { value: null };
         const _result = call("libgio-2.0.so.0", "g_data_input_stream_read_line_finish", [
@@ -217,6 +287,12 @@ export class DataInputStream extends BufferedInputStream {
         }
         return _result;
     }
+    /**
+     * Finish an asynchronous call started by
+     * g_data_input_stream_read_line_async().
+     * @param result - the #GAsyncResult that was provided to the callback.
+     * @param length - a #gsize to get the length of the data read in.
+     */
     readLineFinishUtf8(result, length) {
         const error = { value: null };
         const _result = call("libgio-2.0.so.0", "g_data_input_stream_read_line_finish_utf8", [
@@ -253,6 +329,15 @@ export class DataInputStream extends BufferedInputStream {
         }
         return _result;
     }
+    /**
+     * Reads a UTF-8 encoded line from the data input stream.
+     *
+     * If `cancellable` is not %NULL, then the operation can be cancelled by
+     * triggering the cancellable object from another thread. If the operation
+     * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
+     * @param length - a #gsize to get the length of the data read in.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     readLineUtf8(length, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_input_stream_read_line_utf8", [
@@ -290,6 +375,13 @@ export class DataInputStream extends BufferedInputStream {
         }
         return result;
     }
+    /**
+     * Reads an unsigned 16-bit/2-byte value from @stream.
+     *
+     * In order to get the correct byte order for this read operation,
+     * see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     readUint16(cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_input_stream_read_uint16", [
@@ -319,6 +411,17 @@ export class DataInputStream extends BufferedInputStream {
         }
         return result;
     }
+    /**
+     * Reads an unsigned 32-bit/4-byte value from @stream.
+     *
+     * In order to get the correct byte order for this read operation,
+     * see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
+     *
+     * If `cancellable` is not %NULL, then the operation can be cancelled by
+     * triggering the cancellable object from another thread. If the operation
+     * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     readUint32(cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_input_stream_read_uint32", [
@@ -348,6 +451,17 @@ export class DataInputStream extends BufferedInputStream {
         }
         return result;
     }
+    /**
+     * Reads an unsigned 64-bit/8-byte value from @stream.
+     *
+     * In order to get the correct byte order for this read operation,
+     * see g_data_input_stream_get_byte_order().
+     *
+     * If `cancellable` is not %NULL, then the operation can be cancelled by
+     * triggering the cancellable object from another thread. If the operation
+     * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     readUint64(cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_input_stream_read_uint64", [
@@ -377,6 +491,22 @@ export class DataInputStream extends BufferedInputStream {
         }
         return result;
     }
+    /**
+     * Reads a string from the data input stream, up to the first
+     * occurrence of any of the stop characters.
+     *
+     * Note that, in contrast to g_data_input_stream_read_until_async(),
+     * this function consumes the stop character that it finds.
+     *
+     * Don't use this function in new code.  Its functionality is
+     * inconsistent with g_data_input_stream_read_until_async().  Both
+     * functions will be marked as deprecated in a future release.  Use
+     * g_data_input_stream_read_upto() instead, but note that that function
+     * does not consume the stop character.
+     * @param stopChars - characters to terminate the read.
+     * @param length - a #gsize to get the length of the data read in.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     readUntil(stopChars, length, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_input_stream_read_until", [
@@ -418,6 +548,28 @@ export class DataInputStream extends BufferedInputStream {
         }
         return result;
     }
+    /**
+     * The asynchronous version of g_data_input_stream_read_until().
+     * It is an error to have two outstanding calls to this function.
+     *
+     * Note that, in contrast to g_data_input_stream_read_until(),
+     * this function does not consume the stop character that it finds.  You
+     * must read it for yourself.
+     *
+     * When the operation is finished, `callback` will be called. You
+     * can then call g_data_input_stream_read_until_finish() to get
+     * the result of the operation.
+     *
+     * Don't use this function in new code.  Its functionality is
+     * inconsistent with g_data_input_stream_read_until().  Both functions
+     * will be marked as deprecated in a future release.  Use
+     * g_data_input_stream_read_upto_async() instead.
+     * @param stopChars - characters to terminate the read.
+     * @param ioPriority - the I/O priority of the request
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     * @param callback - callback to call when the request is satisfied.
+     * @param userData - the data to pass to callback function.
+     */
     readUntilAsync(stopChars, ioPriority, cancellable, callback, userData) {
         call("libgio-2.0.so.0", "g_data_input_stream_read_until_async", [
             {
@@ -449,6 +601,12 @@ export class DataInputStream extends BufferedInputStream {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Finish an asynchronous call started by
+     * g_data_input_stream_read_until_async().
+     * @param result - the #GAsyncResult that was provided to the callback.
+     * @param length - a #gsize to get the length of the data read in.
+     */
     readUntilFinish(result, length) {
         const error = { value: null };
         const _result = call("libgio-2.0.so.0", "g_data_input_stream_read_until_finish", [
@@ -485,6 +643,24 @@ export class DataInputStream extends BufferedInputStream {
         }
         return _result;
     }
+    /**
+     * Reads a string from the data input stream, up to the first
+     * occurrence of any of the stop characters.
+     *
+     * In contrast to g_data_input_stream_read_until(), this function
+     * does not consume the stop character. You have to use
+     * g_data_input_stream_read_byte() to get it before calling
+     * g_data_input_stream_read_upto() again.
+     *
+     * Note that `stop_chars` may contain '\0' if `stop_chars_len` is
+     * specified.
+     *
+     * The returned string will always be nul-terminated on success.
+     * @param stopChars - characters to terminate the read
+     * @param stopCharsLen - length of @stop_chars. May be -1 if `stop_chars` is
+     * @param length - a #gsize to get the length of the data read in
+     * @param cancellable - optional #GCancellable object, %NULL to ignore
+     */
     readUpto(stopChars, stopCharsLen, length, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_input_stream_read_upto", [
@@ -530,6 +706,28 @@ export class DataInputStream extends BufferedInputStream {
         }
         return result;
     }
+    /**
+     * The asynchronous version of g_data_input_stream_read_upto().
+     * It is an error to have two outstanding calls to this function.
+     *
+     * In contrast to g_data_input_stream_read_until(), this function
+     * does not consume the stop character. You have to use
+     * g_data_input_stream_read_byte() to get it before calling
+     * g_data_input_stream_read_upto() again.
+     *
+     * Note that `stop_chars` may contain '\0' if `stop_chars_len` is
+     * specified.
+     *
+     * When the operation is finished, `callback` will be called. You
+     * can then call g_data_input_stream_read_upto_finish() to get
+     * the result of the operation.
+     * @param stopChars - characters to terminate the read
+     * @param stopCharsLen - length of @stop_chars. May be -1 if `stop_chars` is
+     * @param ioPriority - the I/O priority of the request
+     * @param cancellable - optional #GCancellable object, %NULL to ignore
+     * @param callback - callback to call when the request is satisfied
+     * @param userData - the data to pass to callback function
+     */
     readUptoAsync(stopChars, stopCharsLen, ioPriority, cancellable, callback, userData) {
         call("libgio-2.0.so.0", "g_data_input_stream_read_upto_async", [
             {
@@ -565,6 +763,18 @@ export class DataInputStream extends BufferedInputStream {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Finish an asynchronous call started by
+     * g_data_input_stream_read_upto_async().
+     *
+     * Note that this function does not consume the stop character. You
+     * have to use g_data_input_stream_read_byte() to get it before calling
+     * g_data_input_stream_read_upto_async() again.
+     *
+     * The returned string will always be nul-terminated on success.
+     * @param result - the #GAsyncResult that was provided to the callback
+     * @param length - a #gsize to get the length of the data read in
+     */
     readUptoFinish(result, length) {
         const error = { value: null };
         const _result = call("libgio-2.0.so.0", "g_data_input_stream_read_upto_finish", [
@@ -601,6 +811,11 @@ export class DataInputStream extends BufferedInputStream {
         }
         return _result;
     }
+    /**
+     * This function sets the byte order for the given @stream. All subsequent
+     * reads from the `stream` will be read in the given @order.
+     * @param order - a #GDataStreamByteOrder to set.
+     */
     setByteOrder(order) {
         call("libgio-2.0.so.0", "g_data_input_stream_set_byte_order", [
             {
@@ -613,6 +828,14 @@ export class DataInputStream extends BufferedInputStream {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the newline type for the @stream.
+     *
+     * Note that using G_DATA_STREAM_NEWLINE_TYPE_ANY is slightly unsafe. If a read
+     * chunk ends in "CR" we must read an additional byte to know if this is "CR" or
+     * "CR LF", and this might block if there is no more data available.
+     * @param type - the type of new line return as #GDataStreamNewlineType.
+     */
     setNewlineType(type) {
         call("libgio-2.0.so.0", "g_data_input_stream_set_newline_type", [
             {

package/dist/generated/gio/data-output-stream.d.ts

@@ -3,23 +3,120 @@ import { Cancellable } from "./cancellable.js";
 import { OutputStream } from "./output-stream.js";
 import * as GLib from "../glib/index.js";
 import { FilterOutputStream } from "./filter-output-stream.js";
+/**
+ * Data output stream implements [class@Gio.OutputStream] and includes functions
+ * for writing data directly to an output stream.
+ */
 export declare class DataOutputStream extends FilterOutputStream {
+    /**
+     * Creates a new data output stream for @base_stream.
+     * @param baseStream - a #GOutputStream.
+     */
     constructor(baseStream: OutputStream);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Gets the byte order for the stream.
+     */
     getByteOrder(): DataStreamByteOrder;
+    /**
+     * Puts a byte into the output stream.
+     * @param data - a #guchar.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putByte(data: number, cancellable?: Cancellable | null): boolean;
+    /**
+     * Puts a signed 16-bit integer into the output stream.
+     * @param data - a #gint16.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putInt16(data: number, cancellable?: Cancellable | null): boolean;
+    /**
+     * Puts a signed 32-bit integer into the output stream.
+     * @param data - a #gint32.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putInt32(data: number, cancellable?: Cancellable | null): boolean;
+    /**
+     * Puts a signed 64-bit integer into the stream.
+     * @param data - a #gint64.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putInt64(data: number, cancellable?: Cancellable | null): boolean;
+    /**
+     * Puts a string into the output stream.
+     * @param str - a string.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putString(str: string, cancellable?: Cancellable | null): boolean;
+    /**
+     * Puts an unsigned 16-bit integer into the output stream.
+     * @param data - a #guint16.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putUint16(data: number, cancellable?: Cancellable | null): boolean;
+    /**
+     * Puts an unsigned 32-bit integer into the stream.
+     * @param data - a #guint32.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putUint32(data: number, cancellable?: Cancellable | null): boolean;
+    /**
+     * Puts an unsigned 64-bit integer into the stream.
+     * @param data - a #guint64.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putUint64(data: number, cancellable?: Cancellable | null): boolean;
+    /**
+     * Sets the byte order of the data output stream to @order.
+     * @param order - a %GDataStreamByteOrder.
+     */
     setByteOrder(order: DataStreamByteOrder): void;
+    /**
+     * Tests if the stream supports the #GSeekableIface.
+     */
     canSeek(): boolean;
+    /**
+     * Tests if the length of the stream can be adjusted with
+     * g_seekable_truncate().
+     */
     canTruncate(): boolean;
+    /**
+     * Seeks in the stream by the given @offset, modified by @type.
+     *
+     * Attempting to seek past the end of the stream will have different
+     * results depending on if the stream is fixed-sized or resizable.  If
+     * the stream is resizable then seeking past the end and then writing
+     * will result in zeros filling the empty space.  Seeking past the end
+     * of a resizable stream and reading will result in EOF.  Seeking past
+     * the end of a fixed-sized stream will fail.
+     *
+     * Any operation that would result in a negative offset will fail.
+     *
+     * If `cancellable` is not %NULL, then the operation can be cancelled by
+     * triggering the cancellable object from another thread. If the operation
+     * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
+     * @param offset - a #goffset.
+     * @param type - a #GSeekType.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     seek(offset: number, type: GLib.SeekType, cancellable?: Cancellable | null): boolean;
+    /**
+     * Tells the current position within the stream.
+     */
     tell(): number;
+    /**
+     * Sets the length of the stream to @offset. If the stream was previously
+     * larger than @offset, the extra data is discarded. If the stream was
+     * previously shorter than @offset, it is extended with NUL ('\0') bytes.
+     *
+     * If `cancellable` is not %NULL, then the operation can be cancelled by
+     * triggering the cancellable object from another thread. If the operation
+     * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
+     * operation was partially finished when the operation was cancelled the
+     * partial result will be returned, without an error.
+     * @param offset - new length for @seekable, in bytes.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     truncate(offset: number, cancellable?: Cancellable | null): boolean;
 }

package/dist/generated/gio/data-output-stream.js

@@ -1,6 +1,10 @@
 import { call } from "@gtkx/native";
 import { NativeError } from "@gtkx/ffi";
 import { FilterOutputStream } from "./filter-output-stream.js";
+/**
+ * Data output stream implements [class@Gio.OutputStream] and includes functions
+ * for writing data directly to an output stream.
+ */
 export class DataOutputStream extends FilterOutputStream {
     constructor(...args) {
         super(...args);
@@ -14,6 +18,9 @@ export class DataOutputStream extends FilterOutputStream {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Gets the byte order for the stream.
+     */
     getByteOrder() {
         return call("libgio-2.0.so.0", "g_data_output_stream_get_byte_order", [
             {
@@ -22,6 +29,11 @@ export class DataOutputStream extends FilterOutputStream {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Puts a byte into the output stream.
+     * @param data - a #guchar.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putByte(data, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_output_stream_put_byte", [
@@ -55,6 +67,11 @@ export class DataOutputStream extends FilterOutputStream {
         }
         return result;
     }
+    /**
+     * Puts a signed 16-bit integer into the output stream.
+     * @param data - a #gint16.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putInt16(data, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_output_stream_put_int16", [
@@ -88,6 +105,11 @@ export class DataOutputStream extends FilterOutputStream {
         }
         return result;
     }
+    /**
+     * Puts a signed 32-bit integer into the output stream.
+     * @param data - a #gint32.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putInt32(data, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_output_stream_put_int32", [
@@ -121,6 +143,11 @@ export class DataOutputStream extends FilterOutputStream {
         }
         return result;
     }
+    /**
+     * Puts a signed 64-bit integer into the stream.
+     * @param data - a #gint64.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putInt64(data, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_output_stream_put_int64", [
@@ -154,6 +181,11 @@ export class DataOutputStream extends FilterOutputStream {
         }
         return result;
     }
+    /**
+     * Puts a string into the output stream.
+     * @param str - a string.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putString(str, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_output_stream_put_string", [
@@ -187,6 +219,11 @@ export class DataOutputStream extends FilterOutputStream {
         }
         return result;
     }
+    /**
+     * Puts an unsigned 16-bit integer into the output stream.
+     * @param data - a #guint16.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putUint16(data, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_output_stream_put_uint16", [
@@ -220,6 +257,11 @@ export class DataOutputStream extends FilterOutputStream {
         }
         return result;
     }
+    /**
+     * Puts an unsigned 32-bit integer into the stream.
+     * @param data - a #guint32.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putUint32(data, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_output_stream_put_uint32", [
@@ -253,6 +295,11 @@ export class DataOutputStream extends FilterOutputStream {
         }
         return result;
     }
+    /**
+     * Puts an unsigned 64-bit integer into the stream.
+     * @param data - a #guint64.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     putUint64(data, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_data_output_stream_put_uint64", [
@@ -286,6 +333,10 @@ export class DataOutputStream extends FilterOutputStream {
         }
         return result;
     }
+    /**
+     * Sets the byte order of the data output stream to @order.
+     * @param order - a %GDataStreamByteOrder.
+     */
     setByteOrder(order) {
         call("libgio-2.0.so.0", "g_data_output_stream_set_byte_order", [
             {
@@ -298,6 +349,9 @@ export class DataOutputStream extends FilterOutputStream {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Tests if the stream supports the #GSeekableIface.
+     */
     canSeek() {
         return call("libgio-2.0.so.0", "g_seekable_can_seek", [
             {
@@ -306,6 +360,10 @@ export class DataOutputStream extends FilterOutputStream {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Tests if the length of the stream can be adjusted with
+     * g_seekable_truncate().
+     */
     canTruncate() {
         return call("libgio-2.0.so.0", "g_seekable_can_truncate", [
             {
@@ -314,6 +372,25 @@ export class DataOutputStream extends FilterOutputStream {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Seeks in the stream by the given @offset, modified by @type.
+     *
+     * Attempting to seek past the end of the stream will have different
+     * results depending on if the stream is fixed-sized or resizable.  If
+     * the stream is resizable then seeking past the end and then writing
+     * will result in zeros filling the empty space.  Seeking past the end
+     * of a resizable stream and reading will result in EOF.  Seeking past
+     * the end of a fixed-sized stream will fail.
+     *
+     * Any operation that would result in a negative offset will fail.
+     *
+     * If `cancellable` is not %NULL, then the operation can be cancelled by
+     * triggering the cancellable object from another thread. If the operation
+     * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
+     * @param offset - a #goffset.
+     * @param type - a #GSeekType.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     seek(offset, type, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_seekable_seek", [
@@ -351,6 +428,9 @@ export class DataOutputStream extends FilterOutputStream {
         }
         return result;
     }
+    /**
+     * Tells the current position within the stream.
+     */
     tell() {
         return call("libgio-2.0.so.0", "g_seekable_tell", [
             {
@@ -359,6 +439,19 @@ export class DataOutputStream extends FilterOutputStream {
             },
         ], { type: "int", size: 64, unsigned: false });
     }
+    /**
+     * Sets the length of the stream to @offset. If the stream was previously
+     * larger than @offset, the extra data is discarded. If the stream was
+     * previously shorter than @offset, it is extended with NUL ('\0') bytes.
+     *
+     * If `cancellable` is not %NULL, then the operation can be cancelled by
+     * triggering the cancellable object from another thread. If the operation
+     * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
+     * operation was partially finished when the operation was cancelled the
+     * partial result will be returned, without an error.
+     * @param offset - new length for @seekable, in bytes.
+     * @param cancellable - optional #GCancellable object, %NULL to ignore.
+     */
     truncate(offset, cancellable) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_seekable_truncate", [