* Author: Alexander Larsson <alexl@redhat.com>
*/
-#include <config.h>
+#include "config.h"
#include <glib.h>
#include <gfileoutputstream.h>
#include <gseekable.h>
#include "gsimpleasyncresult.h"
+#include "gasyncresult.h"
+#include "gcancellable.h"
+#include "gioerror.h"
#include "glibintl.h"
-#include "gioalias.h"
/**
* SECTION:gfileoutputstream
* @short_description: File output streaming operations
- * @include: gio.h
+ * @include: gio/gio.h
* @see_also: #GOutputStream, #GDataOutputStream, #GSeekable
*
+ * GFileOutputStream provides output streams that write their
+ * content to a file.
*
+ * GFileOutputStream implements #GSeekable, which allows the output
+ * 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 output stream, use g_seekable_tell().
+ * To find out if a file output stream supports seeking, use
+ * g_seekable_can_seek().To position a file output stream, use
+ * g_seekable_seek(). To find out if a file output stream supports
+ * truncating, use g_seekable_can_truncate(). To truncate a file output
+ * stream, use g_seekable_truncate().
**/
static void g_file_output_stream_seekable_iface_init (GSeekableIface *iface);
GCancellable *cancellable,
GError **error);
static void g_file_output_stream_real_query_info_async (GFileOutputStream *stream,
- char *attributes,
+ const char *attributes,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
* was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will
* be returned.
*
- * Returns: a #GFileInfo for the @stream, or %NULL on error.
+ * Returns: (transfer full): a #GFileInfo for the @stream, or %NULL on error.
**/
GFileInfo *
g_file_output_stream_query_info (GFileOutputStream *stream,
- char *attributes,
+ const char *attributes,
GCancellable *cancellable,
GError **error)
{
if (class->query_info)
info = class->query_info (stream, attributes, cancellable, error);
else
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Stream doesn't support query_info"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Stream doesn't support query_info"));
if (cancellable)
g_cancellable_pop_current (cancellable);
**/
void
g_file_output_stream_query_info_async (GFileOutputStream *stream,
- char *attributes,
+ const char *attributes,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
if (!g_output_stream_set_pending (output_stream, &error))
{
- g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
+ g_simple_async_report_take_gerror_in_idle (G_OBJECT (stream),
callback,
user_data,
error);
- g_error_free (error);
return;
}
* Finalizes the asynchronous query started
* by g_file_output_stream_query_info_async().
*
- * Returns: A #GFileInfo for the finished query.
+ * Returns: (transfer full): A #GFileInfo for the finished query.
**/
GFileInfo *
g_file_output_stream_query_info_finish (GFileOutputStream *stream,
* g_file_output_stream_get_etag:
* @stream: a #GFileOutputStream.
*
- * Gets the entity tag for the file when its been written.
+ * Gets the entity tag for the file when it has been written.
* This must be called after the stream has been written
- * and closed. As the etag can change while writing.
+ * and closed, as the etag can change while writing.
*
* Returns: the entity tag for the stream.
**/
return etag;
}
-/**
- * g_file_output_stream_tell:
- * @stream: a #GFileOutputStream.
- *
- * Gets the current location within the stream.
- *
- * Returns: a #goffset of the location within the stream.
- **/
-goffset
+static goffset
g_file_output_stream_tell (GFileOutputStream *stream)
{
GFileOutputStreamClass *class;
return g_file_output_stream_tell (G_FILE_OUTPUT_STREAM (seekable));
}
-/**
- * g_file_output_stream_can_seek:
- * @stream: a #GFileOutputStream.
- *
- * Checks if the stream can be seeked.
- *
- * Returns: %TRUE if seeking is supported by the stream.
- **/
-gboolean
+static gboolean
g_file_output_stream_can_seek (GFileOutputStream *stream)
{
GFileOutputStreamClass *class;
return g_file_output_stream_can_seek (G_FILE_OUTPUT_STREAM (seekable));
}
-/**
- * g_file_output_stream_seek:
- * @stream: a #GFileOutputStream.
- * @offset: a #goffset to seek.
- * @type: a #GSeekType.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError, %NULL to ignore.
- *
- * Seeks to a location in a file output stream.
- *
- * Returns: %TRUE if the seek was successful. %FALSE otherwise.
- **/
-gboolean
+static gboolean
g_file_output_stream_seek (GFileOutputStream *stream,
goffset offset,
GSeekType type,
if (!class->seek)
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Seek not supported on stream"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Seek not supported on stream"));
return FALSE;
}
offset, type, cancellable, error);
}
-/**
- * g_file_output_stream_can_truncate:
- * @stream: a #GFileOutputStream.
- *
- * Checks if the stream can be truncated.
- *
- * Returns: %TRUE if stream can be truncated.
- **/
-gboolean
+static gboolean
g_file_output_stream_can_truncate (GFileOutputStream *stream)
{
GFileOutputStreamClass *class;
return g_file_output_stream_can_truncate (G_FILE_OUTPUT_STREAM (seekable));
}
-/**
- * g_file_output_stream_truncate:
- * @stream: a #GFileOutputStream.
- * @size: a #goffset to truncate the stream at.
- * @cancellable: optional #GCancellable object, %NULL to ignore.
- * @error: a #GError, %NULL to ignore.
- *
- * Truncates a file output stream.
- *
- * Returns: %TRUE if @stream is truncated successfully.
- **/
-gboolean
+static gboolean
g_file_output_stream_truncate (GFileOutputStream *stream,
goffset size,
GCancellable *cancellable,
if (!class->truncate_fn)
{
- g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Truncate not supported on stream"));
+ g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Truncate not supported on stream"));
return FALSE;
}
if (class->query_info)
info = class->query_info (G_FILE_OUTPUT_STREAM (object), data->attributes, cancellable, &error);
else
- g_set_error (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
- _("Stream doesn't support query_info"));
+ g_set_error_literal (&error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
+ _("Stream doesn't support query_info"));
if (info == NULL)
- {
- g_simple_async_result_set_from_error (res, error);
- g_error_free (error);
- }
+ g_simple_async_result_take_error (res, error);
else
data->info = info;
}
static void
g_file_output_stream_real_query_info_async (GFileOutputStream *stream,
- char *attributes,
+ const char *attributes,
int io_priority,
GCancellable *cancellable,
GAsyncReadyCallback callback,
return NULL;
}
-
-#define __G_FILE_OUTPUT_STREAM_C__
-#include "gioaliasdef.c"
projects / platform / upstream / glib.git / blobdiff