gconverter.h 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. /* GIO - GLib Input, Output and Streaming Library
  2. *
  3. * Copyright (C) 2009 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. #ifndef __G_CONVERTER_H__
  23. #define __G_CONVERTER_H__
  24. #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25. #error "Only <gio/gio.h> can be included directly."
  26. #endif
  27. #include <gio/giotypes.h>
  28. G_BEGIN_DECLS
  29. #define G_TYPE_CONVERTER (g_converter_get_type ())
  30. #define G_CONVERTER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_CONVERTER, GConverter))
  31. #define G_IS_CONVERTER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_CONVERTER))
  32. #define G_CONVERTER_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_CONVERTER, GConverterIface))
  33. typedef struct _GConverterIface GConverterIface;
  34. /**
  35. * GConverterIface:
  36. * @g_iface: The parent interface.
  37. * @convert: Converts data.
  38. * @reset: Reverts the internal state of the converter to its initial state.
  39. *
  40. * Provides an interface for converting data from one type
  41. * to another type. The conversion can be stateful
  42. * and may fail at any place.
  43. *
  44. * Since: 2.24
  45. **/
  46. struct _GConverterIface
  47. {
  48. GTypeInterface g_iface;
  49. /* Virtual Table */
  50. GConverterResult (* convert) (GConverter *converter,
  51. const void *inbuf,
  52. gsize inbuf_size,
  53. void *outbuf,
  54. gsize outbuf_size,
  55. GConverterFlags flags,
  56. gsize *bytes_read,
  57. gsize *bytes_written,
  58. GError **error);
  59. void (* reset) (GConverter *converter);
  60. };
  61. GIO_AVAILABLE_IN_ALL
  62. GType g_converter_get_type (void) G_GNUC_CONST;
  63. GIO_AVAILABLE_IN_ALL
  64. GConverterResult g_converter_convert (GConverter *converter,
  65. const void *inbuf,
  66. gsize inbuf_size,
  67. void *outbuf,
  68. gsize outbuf_size,
  69. GConverterFlags flags,
  70. gsize *bytes_read,
  71. gsize *bytes_written,
  72. GError **error);
  73. GIO_AVAILABLE_IN_ALL
  74. void g_converter_reset (GConverter *converter);
  75. GIO_AVAILABLE_IN_2_82
  76. GBytes * g_converter_convert_bytes (GConverter *converter,
  77. GBytes *bytes,
  78. GError **error);
  79. G_END_DECLS
  80. #endif /* __G_CONVERTER_H__ */