1  /* GIO - GLib Input, Io 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_FILE_IO_STREAM_H__
      24  #define __G_FILE_IO_STREAM_H__
      25  
      26  #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
      27  #error "Only <gio/gio.h> can be included directly."
      28  #endif
      29  
      30  #include <gio/giostream.h>
      31  
      32  G_BEGIN_DECLS
      33  
      34  #define G_TYPE_FILE_IO_STREAM         (g_file_io_stream_get_type ())
      35  #define G_FILE_IO_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_IO_STREAM, GFileIOStream))
      36  #define G_FILE_IO_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_IO_STREAM, GFileIOStreamClass))
      37  #define G_IS_FILE_IO_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_IO_STREAM))
      38  #define G_IS_FILE_IO_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_IO_STREAM))
      39  #define G_FILE_IO_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_IO_STREAM, GFileIOStreamClass))
      40  
      41  typedef struct _GFileIOStreamClass    GFileIOStreamClass;
      42  typedef struct _GFileIOStreamPrivate  GFileIOStreamPrivate;
      43  
      44  struct _GFileIOStream
      45  {
      46    GIOStream parent_instance;
      47  
      48    /*< private >*/
      49    GFileIOStreamPrivate *priv;
      50  };
      51  
      52  struct _GFileIOStreamClass
      53  {
      54    GIOStreamClass parent_class;
      55  
      56    goffset     (* tell)              (GFileIOStream    *stream);
      57    gboolean    (* can_seek)          (GFileIOStream    *stream);
      58    gboolean    (* seek)	            (GFileIOStream    *stream,
      59                                       goffset               offset,
      60                                       GSeekType             type,
      61                                       GCancellable         *cancellable,
      62                                       GError              **error);
      63    gboolean    (* can_truncate)      (GFileIOStream    *stream);
      64    gboolean    (* truncate_fn)       (GFileIOStream    *stream,
      65                                       goffset               size,
      66                                       GCancellable         *cancellable,
      67                                       GError              **error);
      68    GFileInfo * (* query_info)        (GFileIOStream    *stream,
      69                                       const char           *attributes,
      70                                       GCancellable         *cancellable,
      71                                       GError              **error);
      72    void        (* query_info_async)  (GFileIOStream     *stream,
      73                                       const char            *attributes,
      74                                       int                   io_priority,
      75                                       GCancellable         *cancellable,
      76                                       GAsyncReadyCallback   callback,
      77                                       gpointer              user_data);
      78    GFileInfo * (* query_info_finish) (GFileIOStream     *stream,
      79                                       GAsyncResult         *result,
      80                                       GError              **error);
      81    char      * (* get_etag)          (GFileIOStream    *stream);
      82  
      83    /* Padding for future expansion */
      84    void (*_g_reserved1) (void);
      85    void (*_g_reserved2) (void);
      86    void (*_g_reserved3) (void);
      87    void (*_g_reserved4) (void);
      88    void (*_g_reserved5) (void);
      89  };
      90  
      91  GIO_AVAILABLE_IN_ALL
      92  GType      g_file_io_stream_get_type          (void) G_GNUC_CONST;
      93  
      94  GIO_AVAILABLE_IN_ALL
      95  GFileInfo *g_file_io_stream_query_info        (GFileIOStream    *stream,
      96  					       const char           *attributes,
      97  					       GCancellable         *cancellable,
      98  					       GError              **error);
      99  GIO_AVAILABLE_IN_ALL
     100  void       g_file_io_stream_query_info_async  (GFileIOStream    *stream,
     101  					       const char           *attributes,
     102  					       int                   io_priority,
     103  					       GCancellable         *cancellable,
     104  					       GAsyncReadyCallback   callback,
     105  					       gpointer              user_data);
     106  GIO_AVAILABLE_IN_ALL
     107  GFileInfo *g_file_io_stream_query_info_finish (GFileIOStream    *stream,
     108  					       GAsyncResult         *result,
     109  					       GError              **error);
     110  GIO_AVAILABLE_IN_ALL
     111  char *     g_file_io_stream_get_etag          (GFileIOStream    *stream);
     112  
     113  G_END_DECLS
     114  
     115  #endif /* __G_FILE_FILE_IO_STREAM_H__ */