gmappedfile.h 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. /* GLIB - Library of useful routines for C programming
  2. * gmappedfile.h: Simplified wrapper around the mmap function
  3. *
  4. * Copyright 2005 Matthias Clasen
  5. *
  6. * SPDX-License-Identifier: LGPL-2.1-or-later
  7. *
  8. * This library is free software; you can redistribute it and/or
  9. * modify it under the terms of the GNU Lesser General Public
  10. * License as published by the Free Software Foundation; either
  11. * version 2.1 of the License, or (at your option) any later version.
  12. *
  13. * This library is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16. * Lesser General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU Lesser General Public
  19. * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  20. */
  21. #ifndef __G_MAPPED_FILE_H__
  22. #define __G_MAPPED_FILE_H__
  23. #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  24. #error "Only <glib.h> can be included directly."
  25. #endif
  26. #include <glib/gbytes.h>
  27. #include <glib/gerror.h>
  28. G_BEGIN_DECLS
  29. typedef struct _GMappedFile GMappedFile;
  30. GLIB_AVAILABLE_IN_ALL
  31. GMappedFile *g_mapped_file_new (const gchar *filename,
  32. gboolean writable,
  33. GError **error);
  34. GLIB_AVAILABLE_IN_ALL
  35. GMappedFile *g_mapped_file_new_from_fd (gint fd,
  36. gboolean writable,
  37. GError **error);
  38. GLIB_AVAILABLE_IN_ALL
  39. gsize g_mapped_file_get_length (GMappedFile *file);
  40. GLIB_AVAILABLE_IN_ALL
  41. gchar *g_mapped_file_get_contents (GMappedFile *file);
  42. GLIB_AVAILABLE_IN_2_34
  43. GBytes * g_mapped_file_get_bytes (GMappedFile *file);
  44. GLIB_AVAILABLE_IN_ALL
  45. GMappedFile *g_mapped_file_ref (GMappedFile *file);
  46. GLIB_AVAILABLE_IN_ALL
  47. void g_mapped_file_unref (GMappedFile *file);
  48. GLIB_DEPRECATED_FOR(g_mapped_file_unref)
  49. void g_mapped_file_free (GMappedFile *file);
  50. G_END_DECLS
  51. #endif /* __G_MAPPED_FILE_H__ */