Bumps documentation to 93% symbol coverage, touching most
[platform/upstream/glib.git] / gio / gmemoryinputstream.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: Christian Kellner <gicmo@gnome.org> 
21  */
22
23 #ifndef __G_MEMORY_INPUT_STREAM_H__
24 #define __G_MEMORY_INPUT_STREAM_H__
25
26 #include <glib-object.h>
27 #include <gio/ginputstream.h>
28
29 G_BEGIN_DECLS
30
31 #define G_TYPE_MEMORY_INPUT_STREAM         (g_memory_input_stream_get_type ())
32 #define G_MEMORY_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_MEMORY_INPUT_STREAM, GMemoryInputStream))
33 #define G_MEMORY_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_MEMORY_INPUT_STREAM, GMemoryInputStreamClass))
34 #define G_IS_MEMORY_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_MEMORY_INPUT_STREAM))
35 #define G_IS_MEMORY_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_MEMORY_INPUT_STREAM))
36 #define G_MEMORY_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_MEMORY_INPUT_STREAM, GMemoryInputStreamClass))
37
38 /**
39  * GMemoryInputStream:
40  * 
41  * Implements #GInputStream for arbitrary memory chunks.
42  **/
43 typedef struct _GMemoryInputStream         GMemoryInputStream;
44 typedef struct _GMemoryInputStreamClass    GMemoryInputStreamClass;
45 typedef struct _GMemoryInputStreamPrivate  GMemoryInputStreamPrivate;
46
47 struct _GMemoryInputStream
48 {
49   GInputStream parent;
50
51   /*< private >*/
52   GMemoryInputStreamPrivate *priv;
53 };
54
55 struct _GMemoryInputStreamClass
56 {
57  GInputStreamClass parent_class;
58
59   /* Padding for future expansion */
60   void (*_g_reserved1) (void);
61   void (*_g_reserved2) (void);
62   void (*_g_reserved3) (void);
63   void (*_g_reserved4) (void);
64   void (*_g_reserved5) (void);
65 };
66
67
68 GType          g_memory_input_stream_get_type  (void) G_GNUC_CONST;
69 GInputStream * g_memory_input_stream_from_data     (const void         *data,
70                                                     gssize              len);
71 void           g_memory_input_stream_set_free_data (GMemoryInputStream *stream,
72                                                     gboolean            free_data);
73 const void    *g_memory_input_stream_get_data      (GMemoryInputStream *stream);
74 gsize          g_memory_input_stream_get_data_size (GMemoryInputStream *stream);
75
76 G_END_DECLS
77
78 #endif /* __G_MEMORY_INPUT_STREAM_H__ */