glib-2.0/gio/gconverter.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2009 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_CONVERTER_H__
0024 #define __G_CONVERTER_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/giotypes.h>
0031
0032 G_BEGIN_DECLS
0033
0034 #define G_TYPE_CONVERTER            (g_converter_get_type ())
0035 #define G_CONVERTER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_CONVERTER, GConverter))
0036 #define G_IS_CONVERTER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_CONVERTER))
0037 #define G_CONVERTER_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_CONVERTER, GConverterIface))
0038
0039 typedef struct _GConverterIface   GConverterIface;
0040
0041 /**
0042  * GConverterIface:
0043  * @g_iface: The parent interface.
0044  * @convert: Converts data.
0045  * @reset: Reverts the internal state of the converter to its initial state.
0046  *
0047  * Provides an interface for converting data from one type
0048  * to another type. The conversion can be stateful
0049  * and may fail at any place.
0050  *
0051  * Since: 2.24
0052  **/
0053 struct _GConverterIface
0054 {
0055   GTypeInterface g_iface;
0056
0057   /* Virtual Table */
0058
0059   GConverterResult (* convert) (GConverter *converter,
0060                 const void *inbuf,
0061                 gsize       inbuf_size,
0062                 void       *outbuf,
0063                 gsize       outbuf_size,
0064                 GConverterFlags flags,
0065                 gsize      *bytes_read,
0066                 gsize      *bytes_written,
0067                 GError    **error);
0068   void  (* reset)   (GConverter *converter);
0069 };
0070
0071 GIO_AVAILABLE_IN_ALL
0072 GType            g_converter_get_type     (void) G_GNUC_CONST;
0073
0074 GIO_AVAILABLE_IN_ALL
0075 GConverterResult g_converter_convert (GConverter       *converter,
0076                       const void       *inbuf,
0077                       gsize             inbuf_size,
0078                       void             *outbuf,
0079                       gsize             outbuf_size,
0080                       GConverterFlags   flags,
0081                       gsize            *bytes_read,
0082                       gsize            *bytes_written,
0083                       GError          **error);
0084 GIO_AVAILABLE_IN_ALL
0085 void             g_converter_reset   (GConverter       *converter);
0086
0087 GIO_AVAILABLE_IN_2_82
0088 GBytes *         g_converter_convert_bytes (GConverter  *converter,
0089                                             GBytes      *bytes,
0090                                             GError     **error);
0091
0092
0093 G_END_DECLS
0094
0095
0096 #endif /* __G_CONVERTER_H__ */