Improve docs
[glib.git] / gio / gmemoryinputstream.h
blob0aa120024437f46370ee8ae4fecefc43668a22e8
1 /* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
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.
20 * Author: Christian Kellner <gicmo@gnome.org>
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
25 #endif
27 #ifndef __G_MEMORY_INPUT_STREAM_H__
28 #define __G_MEMORY_INPUT_STREAM_H__
30 #include <gio/ginputstream.h>
32 G_BEGIN_DECLS
34 #define G_TYPE_MEMORY_INPUT_STREAM (g_memory_input_stream_get_type ())
35 #define G_MEMORY_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_MEMORY_INPUT_STREAM, GMemoryInputStream))
36 #define G_MEMORY_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_MEMORY_INPUT_STREAM, GMemoryInputStreamClass))
37 #define G_IS_MEMORY_INPUT_STREAM(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_MEMORY_INPUT_STREAM))
38 #define G_IS_MEMORY_INPUT_STREAM_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_MEMORY_INPUT_STREAM))
39 #define G_MEMORY_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_MEMORY_INPUT_STREAM, GMemoryInputStreamClass))
41 /**
42 * GMemoryInputStream:
44 * Implements #GInputStream for arbitrary memory chunks.
45 **/
46 typedef struct _GMemoryInputStreamClass GMemoryInputStreamClass;
47 typedef struct _GMemoryInputStreamPrivate GMemoryInputStreamPrivate;
49 struct _GMemoryInputStream
51 GInputStream parent_instance;
53 /*< private >*/
54 GMemoryInputStreamPrivate *priv;
57 struct _GMemoryInputStreamClass
59 GInputStreamClass parent_class;
61 /* Padding for future expansion */
62 void (*_g_reserved1) (void);
63 void (*_g_reserved2) (void);
64 void (*_g_reserved3) (void);
65 void (*_g_reserved4) (void);
66 void (*_g_reserved5) (void);
70 GType g_memory_input_stream_get_type (void) G_GNUC_CONST;
71 GInputStream * g_memory_input_stream_new (void);
72 GInputStream * g_memory_input_stream_new_from_data (const void *data,
73 gssize len,
74 GDestroyNotify destroy);
75 void g_memory_input_stream_add_data (GMemoryInputStream *stream,
76 const void *data,
77 gssize len,
78 GDestroyNotify destroy);
80 G_END_DECLS
82 #endif /* __G_MEMORY_INPUT_STREAM_H__ */