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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_FILE_OUTPUT_STREAM_H__
  28 #define __G_FILE_OUTPUT_STREAM_H__
  29
  30 #include <gio/goutputstream.h>
  31 #include <gio/gfileinfo.h>
  32
  33 G_BEGIN_DECLS
  34
  35 #define G_TYPE_FILE_OUTPUT_STREAM         (g_file_output_stream_get_type ())
  36 #define G_FILE_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStream))
  37 #define G_FILE_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
  38 #define G_IS_FILE_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_OUTPUT_STREAM))
  39 #define G_IS_FILE_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_OUTPUT_STREAM))
  40 #define G_FILE_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
  41
  42 /**
  43  * GFileOutputStream:
  44  *
  45  * A subclass of GOutputStream for opened files. This adds
  46  * a few file-specific operations and seeking and truncating.
  47  *
  48  * #GFileOutputStream implements GSeekable.
  49  **/
  50 typedef struct _GFileOutputStream         GFileOutputStream;
  51 typedef struct _GFileOutputStreamClass    GFileOutputStreamClass;
  52 typedef struct _GFileOutputStreamPrivate  GFileOutputStreamPrivate;
  53
  54 struct _GFileOutputStream
  55 {
  56   GOutputStream parent_instance;
  57
  58   /*< private >*/
  59   GFileOutputStreamPrivate *priv;
  60 };
  61
  62 struct _GFileOutputStreamClass
  63 {
  64   GOutputStreamClass parent_class;
  65
  66   goffset    (*tell)          (GFileOutputStream     *stream);
  67   gboolean   (*can_seek)      (GFileOutputStream     *stream);
  68   gboolean   (*seek)          (GFileOutputStream     *stream,
  69                                goffset               offset,
  70                                GSeekType             type,
  71                                GCancellable         *cancellable,
  72                                GError              **error);
  73   gboolean   (*can_truncate)  (GFileOutputStream    *stream);
  74   gboolean   (*truncate_fn)   (GFileOutputStream    *stream,
  75                                goffset               size,
  76                                GCancellable         *cancellable,
  77                                GError              **error);
  78   GFileInfo *(*query_info)    (GFileOutputStream    *stream,
  79                                char                 *attributes,
  80                                GCancellable         *cancellable,
  81                                GError              **error);
  82   void       (*query_info_async)  (GFileOutputStream     *stream,
  83                                    char                 *attributes,
  84                                    int                   io_priority,
  85                                    GCancellable         *cancellable,
  86                                    GAsyncReadyCallback   callback,
  87                                    gpointer              user_data);
  88   GFileInfo *(*query_info_finish) (GFileOutputStream     *stream,
  89                                    GAsyncResult         *res,
  90                                    GError              **error);
  91   char      *(*get_etag)      (GFileOutputStream    *stream);
  92
  93   /* Padding for future expansion */
  94   void (*_g_reserved1) (void);
  95   void (*_g_reserved2) (void);
  96   void (*_g_reserved3) (void);
  97   void (*_g_reserved4) (void);
  98   void (*_g_reserved5) (void);
  99 };
 100
 101 GType g_file_output_stream_get_type (void) G_GNUC_CONST;
 102
 103
 104 GFileInfo *g_file_output_stream_query_info (GFileOutputStream  *stream,
 105                                             char               *attributes,
 106                                             GCancellable       *cancellable,
 107                                             GError            **error);
 108 void       g_file_output_stream_query_info_async  (GFileOutputStream     *stream,
 109                                                    char                 *attributes,
 110                                                    int                   io_priority,
 111                                                    GCancellable         *cancellable,
 112                                                    GAsyncReadyCallback   callback,
 113                                                    gpointer              user_data);
 114 GFileInfo *g_file_output_stream_query_info_finish (GFileOutputStream     *stream,
 115                                                    GAsyncResult         *result,
 116                                                    GError              **error);
 117 char *     g_file_output_stream_get_etag      (GFileOutputStream  *stream);
 118 goffset    g_file_output_stream_tell          (GFileOutputStream  *stream);
 119 gboolean   g_file_output_stream_can_seek      (GFileOutputStream  *stream);
 120 gboolean   g_file_output_stream_seek          (GFileOutputStream  *stream,
 121                                                goffset             offset,
 122                                                GSeekType           type,
 123                                                GCancellable       *cancellable,
 124                                                GError            **error);
 125 gboolean   g_file_output_stream_can_truncate  (GFileOutputStream  *stream);
 126 gboolean   g_file_output_stream_truncate      (GFileOutputStream  *stream,
 127                                                goffset             size,
 128                                                GCancellable       *cancellable,
 129                                                GError            **error);
 130
 131 G_END_DECLS
 132
 133 #endif /* __G_FILE_FILE_OUTPUT_STREAM_H__ */