gio/glocalfileoutputstream.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_LOCAL_FILE_OUTPUT_STREAM_H__
  24 #define __G_LOCAL_FILE_OUTPUT_STREAM_H__
  25
  26 #include <gio/gfileoutputstream.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define G_TYPE_LOCAL_FILE_OUTPUT_STREAM         (_g_local_file_output_stream_get_type ())
  31 #define G_LOCAL_FILE_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_LOCAL_FILE_OUTPUT_STREAM, GLocalFileOutputStream))
  32 #define G_LOCAL_FILE_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_LOCAL_FILE_OUTPUT_STREAM, GLocalFileOutputStreamClass))
  33 #define G_IS_LOCAL_FILE_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_LOCAL_FILE_OUTPUT_STREAM))
  34 #define G_IS_LOCAL_FILE_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_LOCAL_FILE_OUTPUT_STREAM))
  35 #define G_LOCAL_FILE_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_LOCAL_FILE_OUTPUT_STREAM, GLocalFileOutputStreamClass))
  36
  37 typedef struct _GLocalFileOutputStream         GLocalFileOutputStream;
  38 typedef struct _GLocalFileOutputStreamClass    GLocalFileOutputStreamClass;
  39 typedef struct _GLocalFileOutputStreamPrivate  GLocalFileOutputStreamPrivate;
  40
  41 struct _GLocalFileOutputStream
  42 {
  43   GFileOutputStream parent_instance;
  44
  45   /*< private >*/
  46   GLocalFileOutputStreamPrivate *priv;
  47 };
  48
  49 struct _GLocalFileOutputStreamClass
  50 {
  51   GFileOutputStreamClass parent_class;
  52 };
  53
  54 GType               _g_local_file_output_stream_get_type (void) G_GNUC_CONST;
  55
  56 void     _g_local_file_output_stream_set_do_close (GLocalFileOutputStream *out,
  57                                                    gboolean do_close);
  58 gboolean _g_local_file_output_stream_really_close (GLocalFileOutputStream *out,
  59                                                    GCancellable   *cancellable,
  60                                                    GError        **error);
  61
  62 GFileOutputStream * _g_local_file_output_stream_new      (int               fd);
  63 GFileOutputStream * _g_local_file_output_stream_open     (const char       *filename,
  64                                                           gboolean          readable,
  65                                                           GCancellable     *cancellable,
  66                                                           GError          **error);
  67 GFileOutputStream * _g_local_file_output_stream_create   (const char       *filename,
  68                                                           gboolean          readable,
  69                                                           GFileCreateFlags  flags,
  70                                                           GFileInfo        *reference_info,
  71                                                           GCancellable     *cancellable,
  72                                                           GError          **error);
  73 GFileOutputStream * _g_local_file_output_stream_append   (const char       *filename,
  74                                                           GFileCreateFlags  flags,
  75                                                           GCancellable     *cancellable,
  76                                                           GError          **error);
  77 GFileOutputStream * _g_local_file_output_stream_replace  (const char       *filename,
  78                                                           gboolean          readable,
  79                                                           const char       *etag,
  80                                                           gboolean          create_backup,
  81                                                           GFileCreateFlags  flags,
  82                                                           GFileInfo        *reference_info,
  83                                                           GCancellable     *cancellable,
  84                                                           GError          **error);
  85
  86 /* Hack to get the fd since GFileDescriptorBased (which is how you
  87  * _should_ get the fd) is only available on UNIX but things like
  88  * win32 needs this as well
  89  */
  90 gint _g_local_file_output_stream_get_fd (GLocalFileOutputStream *output_stream);
  91
  92 G_END_DECLS
  93
  94 #endif /* __G_LOCAL_FILE_OUTPUT_STREAM_H__ */