gio/gfileoutputstream.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   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 of the License, or (at your option) any later version.
   9  *
  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.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_FILE_OUTPUT_STREAM_H__
  24 #define __G_FILE_OUTPUT_STREAM_H__
  25
  26 #include <gio/goutputstream.h>
  27 #include <gio/gfileinfo.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define G_TYPE_FILE_OUTPUT_STREAM         (g_file_output_stream_get_type ())
  32 #define G_FILE_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStream))
  33 #define G_FILE_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
  34 #define G_IS_FILE_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_OUTPUT_STREAM))
  35 #define G_IS_FILE_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_OUTPUT_STREAM))
  36 #define G_FILE_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
  37
  38 /**
  39  * GFileOutputStream:
  40  * @parent: The parent #GOutputStream instance.
  41  *
  42  * Implements #GOutputStream and #GSeekable for file output operations.
  43  **/
  44 typedef struct _GFileOutputStream         GFileOutputStream;
  45 typedef struct _GFileOutputStreamClass    GFileOutputStreamClass;
  46 typedef struct _GFileOutputStreamPrivate  GFileOutputStreamPrivate;
  47
  48 struct _GFileOutputStream
  49 {
  50   GOutputStream parent;
  51
  52   /*< private >*/
  53   GFileOutputStreamPrivate *priv;
  54 };
  55
  56 struct _GFileOutputStreamClass
  57 {
  58   GOutputStreamClass parent_class;
  59
  60   goffset    (*tell)          (GFileOutputStream     *stream);
  61   gboolean   (*can_seek)      (GFileOutputStream     *stream);
  62   gboolean   (*seek)          (GFileOutputStream     *stream,
  63                                goffset               offset,
  64                                GSeekType             type,
  65                                GCancellable         *cancellable,
  66                                GError              **error);
  67   gboolean   (*can_truncate)  (GFileOutputStream    *stream);
  68   gboolean   (*truncate_fn)   (GFileOutputStream    *stream,
  69                                goffset               size,
  70                                GCancellable         *cancellable,
  71                                GError              **error);
  72   GFileInfo *(*query_info)    (GFileOutputStream    *stream,
  73                                char                 *attributes,
  74                                GCancellable         *cancellable,
  75                                GError              **error);
  76   void       (*query_info_async)  (GFileOutputStream     *stream,
  77                                    char                 *attributes,
  78                                    int                   io_priority,
  79                                    GCancellable         *cancellable,
  80                                    GAsyncReadyCallback   callback,
  81                                    gpointer              user_data);
  82   GFileInfo *(*query_info_finish) (GFileOutputStream     *stream,
  83                                    GAsyncResult         *res,
  84                                    GError              **error);
  85   char      *(*get_etag)      (GFileOutputStream    *stream);
  86
  87   /* Padding for future expansion */
  88   void (*_g_reserved1) (void);
  89   void (*_g_reserved2) (void);
  90   void (*_g_reserved3) (void);
  91   void (*_g_reserved4) (void);
  92   void (*_g_reserved5) (void);
  93 };
  94
  95 GType g_file_output_stream_get_type (void) G_GNUC_CONST;
  96
  97
  98 GFileInfo *g_file_output_stream_query_info (GFileOutputStream  *stream,
  99                                             char               *attributes,
 100                                             GCancellable       *cancellable,
 101                                             GError            **error);
 102 void       g_file_output_stream_query_info_async  (GFileOutputStream     *stream,
 103                                                    char                 *attributes,
 104                                                    int                   io_priority,
 105                                                    GCancellable         *cancellable,
 106                                                    GAsyncReadyCallback   callback,
 107                                                    gpointer              user_data);
 108 GFileInfo *g_file_output_stream_query_info_finish (GFileOutputStream     *stream,
 109                                                    GAsyncResult         *result,
 110                                                    GError              **error);
 111 char *     g_file_output_stream_get_etag      (GFileOutputStream  *stream);
 112 goffset    g_file_output_stream_tell          (GFileOutputStream  *stream);
 113 gboolean   g_file_output_stream_can_seek      (GFileOutputStream  *stream);
 114 gboolean   g_file_output_stream_seek          (GFileOutputStream  *stream,
 115                                                goffset             offset,
 116                                                GSeekType           type,
 117                                                GCancellable       *cancellable,
 118                                                GError            **error);
 119 gboolean   g_file_output_stream_can_truncate  (GFileOutputStream  *stream);
 120 gboolean   g_file_output_stream_truncate      (GFileOutputStream  *stream,
 121                                                goffset             size,
 122                                                GCancellable       *cancellable,
 123                                                GError            **error);
 124
 125 G_END_DECLS
 126
 127 #endif /* __G_FILE_FILE_OUTPUT_STREAM_H__ */