1 /* GLIB - Library of useful routines for C programming
2 * gmappedfile.h: Simplified wrapper around the mmap function
4 * Copyright 2005 Matthias Clasen
6 * SPDX-License-Identifier: LGPL-2.1-or-later
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.
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.
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/>.
22 #ifndef __G_MAPPED_FILE_H__
23 #define __G_MAPPED_FILE_H__
25 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
26 #error "Only <glib.h> can be included directly."
29 #include <glib/gbytes.h>
30 #include <glib/gerror.h>
34 typedef struct _GMappedFile GMappedFile;
37 GMappedFile *g_mapped_file_new (const gchar *filename,
41 GMappedFile *g_mapped_file_new_from_fd (gint fd,
45 gsize g_mapped_file_get_length (GMappedFile *file);
47 gchar *g_mapped_file_get_contents (GMappedFile *file);
48 GLIB_AVAILABLE_IN_2_34
49 GBytes * g_mapped_file_get_bytes (GMappedFile *file);
51 GMappedFile *g_mapped_file_ref (GMappedFile *file);
53 void g_mapped_file_unref (GMappedFile *file);
55 GLIB_DEPRECATED_FOR(g_mapped_file_unref)
56 void g_mapped_file_free (GMappedFile *file);
60 #endif /* __G_MAPPED_FILE_H__ */