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_FILE_INPUT_STREAM_H__
24#define __G_FILE_INPUT_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/ginputstream.h>
31
32G_BEGIN_DECLS
33
34#define G_TYPE_FILE_INPUT_STREAM (g_file_input_stream_get_type ())
35#define G_FILE_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStream))
36#define G_FILE_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass))
37#define G_IS_FILE_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_INPUT_STREAM))
38#define G_IS_FILE_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_INPUT_STREAM))
39#define G_FILE_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass))
40
41typedef struct _GFileInputStreamClass GFileInputStreamClass;
42typedef struct _GFileInputStreamPrivate GFileInputStreamPrivate;
43
44struct _GFileInputStream
45{
46 GInputStream parent_instance;
47
48 /*< private >*/
49 GFileInputStreamPrivate *priv;
50};
51
52struct _GFileInputStreamClass
53{
54 GInputStreamClass parent_class;
55
56 goffset (* tell) (GFileInputStream *stream);
57 gboolean (* can_seek) (GFileInputStream *stream);
58 gboolean (* seek) (GFileInputStream *stream,
59 goffset offset,
60 GSeekType type,
61 GCancellable *cancellable,
62 GError **error);
63 GFileInfo * (* query_info) (GFileInputStream *stream,
64 const char *attributes,
65 GCancellable *cancellable,
66 GError **error);
67 void (* query_info_async) (GFileInputStream *stream,
68 const char *attributes,
69 int io_priority,
70 GCancellable *cancellable,
71 GAsyncReadyCallback callback,
72 gpointer user_data);
73 GFileInfo * (* query_info_finish) (GFileInputStream *stream,
74 GAsyncResult *result,
75 GError **error);
76
77 /*< private >*/
78 /* Padding for future expansion */
79 void (*_g_reserved1) (void);
80 void (*_g_reserved2) (void);
81 void (*_g_reserved3) (void);
82 void (*_g_reserved4) (void);
83 void (*_g_reserved5) (void);
84};
85
86GIO_AVAILABLE_IN_ALL
87GType g_file_input_stream_get_type (void) G_GNUC_CONST;
88
89GIO_AVAILABLE_IN_ALL
90GFileInfo *g_file_input_stream_query_info (GFileInputStream *stream,
91 const char *attributes,
92 GCancellable *cancellable,
93 GError **error);
94GIO_AVAILABLE_IN_ALL
95void g_file_input_stream_query_info_async (GFileInputStream *stream,
96 const char *attributes,
97 int io_priority,
98 GCancellable *cancellable,
99 GAsyncReadyCallback callback,
100 gpointer user_data);
101GIO_AVAILABLE_IN_ALL
102GFileInfo *g_file_input_stream_query_info_finish (GFileInputStream *stream,
103 GAsyncResult *result,
104 GError **error);
105
106G_END_DECLS
107
108#endif /* __G_FILE_FILE_INPUT_STREAM_H__ */
109