Merge branch '976-disable-assert-checks' into 'master'
[glib.git] / gio / gfileoutputstream.h
blob5df63efba7d9b1125a6501dd13eb4c292006896d
1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 * Author: Alexander Larsson <alexl@redhat.com>
21 #ifndef __G_FILE_OUTPUT_STREAM_H__
22 #define __G_FILE_OUTPUT_STREAM_H__
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
26 #endif
28 #include <gio/goutputstream.h>
30 G_BEGIN_DECLS
32 #define G_TYPE_FILE_OUTPUT_STREAM (g_file_output_stream_get_type ())
33 #define G_FILE_OUTPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStream))
34 #define G_FILE_OUTPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
35 #define G_IS_FILE_OUTPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_OUTPUT_STREAM))
36 #define G_IS_FILE_OUTPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_OUTPUT_STREAM))
37 #define G_FILE_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
39 /**
40 * GFileOutputStream:
42 * A subclass of GOutputStream for opened files. This adds
43 * a few file-specific operations and seeking and truncating.
45 * #GFileOutputStream implements GSeekable.
46 **/
47 typedef struct _GFileOutputStreamClass GFileOutputStreamClass;
48 typedef struct _GFileOutputStreamPrivate GFileOutputStreamPrivate;
50 struct _GFileOutputStream
52 GOutputStream parent_instance;
54 /*< private >*/
55 GFileOutputStreamPrivate *priv;
58 struct _GFileOutputStreamClass
60 GOutputStreamClass parent_class;
62 goffset (* tell) (GFileOutputStream *stream);
63 gboolean (* can_seek) (GFileOutputStream *stream);
64 gboolean (* seek) (GFileOutputStream *stream,
65 goffset offset,
66 GSeekType type,
67 GCancellable *cancellable,
68 GError **error);
69 gboolean (* can_truncate) (GFileOutputStream *stream);
70 gboolean (* truncate_fn) (GFileOutputStream *stream,
71 goffset size,
72 GCancellable *cancellable,
73 GError **error);
74 GFileInfo * (* query_info) (GFileOutputStream *stream,
75 const char *attributes,
76 GCancellable *cancellable,
77 GError **error);
78 void (* query_info_async) (GFileOutputStream *stream,
79 const char *attributes,
80 int io_priority,
81 GCancellable *cancellable,
82 GAsyncReadyCallback callback,
83 gpointer user_data);
84 GFileInfo * (* query_info_finish) (GFileOutputStream *stream,
85 GAsyncResult *result,
86 GError **error);
87 char * (* get_etag) (GFileOutputStream *stream);
89 /* Padding for future expansion */
90 void (*_g_reserved1) (void);
91 void (*_g_reserved2) (void);
92 void (*_g_reserved3) (void);
93 void (*_g_reserved4) (void);
94 void (*_g_reserved5) (void);
97 GLIB_AVAILABLE_IN_ALL
98 GType g_file_output_stream_get_type (void) G_GNUC_CONST;
101 GLIB_AVAILABLE_IN_ALL
102 GFileInfo *g_file_output_stream_query_info (GFileOutputStream *stream,
103 const char *attributes,
104 GCancellable *cancellable,
105 GError **error);
106 GLIB_AVAILABLE_IN_ALL
107 void g_file_output_stream_query_info_async (GFileOutputStream *stream,
108 const char *attributes,
109 int io_priority,
110 GCancellable *cancellable,
111 GAsyncReadyCallback callback,
112 gpointer user_data);
113 GLIB_AVAILABLE_IN_ALL
114 GFileInfo *g_file_output_stream_query_info_finish (GFileOutputStream *stream,
115 GAsyncResult *result,
116 GError **error);
117 GLIB_AVAILABLE_IN_ALL
118 char * g_file_output_stream_get_etag (GFileOutputStream *stream);
120 G_END_DECLS
122 #endif /* __G_FILE_FILE_OUTPUT_STREAM_H__ */