glib-2.0/gio/gfileinputstream.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2006-2007 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Author: Alexander Larsson <alexl@redhat.com>
0021  */
0022
0023 #ifndef __G_FILE_INPUT_STREAM_H__
0024 #define __G_FILE_INPUT_STREAM_H__
0025
0026 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0027 #error "Only <gio/gio.h> can be included directly."
0028 #endif
0029
0030 #include <gio/ginputstream.h>
0031
0032 G_BEGIN_DECLS
0033
0034 #define G_TYPE_FILE_INPUT_STREAM         (g_file_input_stream_get_type ())
0035 #define G_FILE_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStream))
0036 #define G_FILE_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass))
0037 #define G_IS_FILE_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_INPUT_STREAM))
0038 #define G_IS_FILE_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_INPUT_STREAM))
0039 #define G_FILE_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass))
0040
0041 typedef struct _GFileInputStreamClass    GFileInputStreamClass;
0042 typedef struct _GFileInputStreamPrivate  GFileInputStreamPrivate;
0043
0044 struct _GFileInputStream
0045 {
0046   GInputStream parent_instance;
0047
0048   /*< private >*/
0049   GFileInputStreamPrivate *priv;
0050 };
0051
0052 struct _GFileInputStreamClass
0053 {
0054   GInputStreamClass parent_class;
0055
0056   goffset     (* tell)              (GFileInputStream     *stream);
0057   gboolean    (* can_seek)          (GFileInputStream     *stream);
0058   gboolean    (* seek)              (GFileInputStream     *stream,
0059                                      goffset               offset,
0060                                      GSeekType             type,
0061                                      GCancellable         *cancellable,
0062                                      GError              **error);
0063   GFileInfo * (* query_info)        (GFileInputStream     *stream,
0064                                      const char           *attributes,
0065                                      GCancellable         *cancellable,
0066                                      GError              **error);
0067   void        (* query_info_async)  (GFileInputStream     *stream,
0068                                      const char           *attributes,
0069                                      int                   io_priority,
0070                                      GCancellable         *cancellable,
0071                                      GAsyncReadyCallback   callback,
0072                                      gpointer              user_data);
0073   GFileInfo * (* query_info_finish) (GFileInputStream     *stream,
0074                                      GAsyncResult         *result,
0075                                      GError              **error);
0076
0077   /*< private >*/
0078   /* Padding for future expansion */
0079   void (*_g_reserved1) (void);
0080   void (*_g_reserved2) (void);
0081   void (*_g_reserved3) (void);
0082   void (*_g_reserved4) (void);
0083   void (*_g_reserved5) (void);
0084 };
0085
0086 GIO_AVAILABLE_IN_ALL
0087 GType      g_file_input_stream_get_type          (void) G_GNUC_CONST;
0088
0089 GIO_AVAILABLE_IN_ALL
0090 GFileInfo *g_file_input_stream_query_info        (GFileInputStream     *stream,
0091                           const char           *attributes,
0092                           GCancellable         *cancellable,
0093                           GError              **error);
0094 GIO_AVAILABLE_IN_ALL
0095 void       g_file_input_stream_query_info_async  (GFileInputStream     *stream,
0096                           const char           *attributes,
0097                           int                   io_priority,
0098                           GCancellable         *cancellable,
0099                           GAsyncReadyCallback   callback,
0100                           gpointer              user_data);
0101 GIO_AVAILABLE_IN_ALL
0102 GFileInfo *g_file_input_stream_query_info_finish (GFileInputStream     *stream,
0103                           GAsyncResult         *result,
0104                           GError              **error);
0105
0106 G_END_DECLS
0107
0108 #endif /* __G_FILE_FILE_INPUT_STREAM_H__ */