glib (2.79.0)
       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: Christian Kellner <gicmo@gnome.org>
      21   */
      22  
      23  #ifndef __G_MEMORY_OUTPUT_STREAM_H__
      24  #define __G_MEMORY_OUTPUT_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/goutputstream.h>
      31  
      32  G_BEGIN_DECLS
      33  
      34  #define G_TYPE_MEMORY_OUTPUT_STREAM         (g_memory_output_stream_get_type ())
      35  #define G_MEMORY_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_MEMORY_OUTPUT_STREAM, GMemoryOutputStream))
      36  #define G_MEMORY_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_MEMORY_OUTPUT_STREAM, GMemoryOutputStreamClass))
      37  #define G_IS_MEMORY_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_MEMORY_OUTPUT_STREAM))
      38  #define G_IS_MEMORY_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_MEMORY_OUTPUT_STREAM))
      39  #define G_MEMORY_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_MEMORY_OUTPUT_STREAM, GMemoryOutputStreamClass))
      40  
      41  typedef struct _GMemoryOutputStreamClass    GMemoryOutputStreamClass;
      42  typedef struct _GMemoryOutputStreamPrivate  GMemoryOutputStreamPrivate;
      43  
      44  struct _GMemoryOutputStream
      45  {
      46    GOutputStream parent_instance;
      47  
      48    /*< private >*/
      49    GMemoryOutputStreamPrivate *priv;
      50  };
      51  
      52  struct _GMemoryOutputStreamClass
      53  {
      54    GOutputStreamClass parent_class;
      55  
      56    /*< private >*/
      57    /* Padding for future expansion */
      58    void (*_g_reserved1) (void);
      59    void (*_g_reserved2) (void);
      60    void (*_g_reserved3) (void);
      61    void (*_g_reserved4) (void);
      62    void (*_g_reserved5) (void);
      63  };
      64  
      65  /**
      66   * GReallocFunc:
      67   * @data: memory block to reallocate
      68   * @size: size to reallocate @data to
      69   *
      70   * Changes the size of the memory block pointed to by @data to
      71   * @size bytes.
      72   *
      73   * The function should have the same semantics as realloc().
      74   *
      75   * Returns: a pointer to the reallocated memory
      76   */
      77  typedef gpointer (* GReallocFunc) (gpointer data,
      78                                     gsize    size);
      79  
      80  GIO_AVAILABLE_IN_ALL
      81  GType          g_memory_output_stream_get_type      (void) G_GNUC_CONST;
      82  
      83  GIO_AVAILABLE_IN_ALL
      84  GOutputStream *g_memory_output_stream_new           (gpointer             data,
      85                                                       gsize                size,
      86                                                       GReallocFunc         realloc_function,
      87                                                       GDestroyNotify       destroy_function);
      88  GIO_AVAILABLE_IN_2_36
      89  GOutputStream *g_memory_output_stream_new_resizable (void);
      90  GIO_AVAILABLE_IN_ALL
      91  gpointer       g_memory_output_stream_get_data      (GMemoryOutputStream *ostream);
      92  GIO_AVAILABLE_IN_ALL
      93  gsize          g_memory_output_stream_get_size      (GMemoryOutputStream *ostream);
      94  GIO_AVAILABLE_IN_ALL
      95  gsize          g_memory_output_stream_get_data_size (GMemoryOutputStream *ostream);
      96  GIO_AVAILABLE_IN_ALL
      97  gpointer       g_memory_output_stream_steal_data    (GMemoryOutputStream *ostream);
      98  
      99  GIO_AVAILABLE_IN_2_34
     100  GBytes *       g_memory_output_stream_steal_as_bytes (GMemoryOutputStream *ostream);
     101  
     102  G_END_DECLS
     103  
     104  #endif /* __G_MEMORY_OUTPUT_STREAM_H__ */