libasdf-rs 0.2.2

Drop-in C ABI replacement for libasdf, implemented in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

/**
 * .. _asdf/util.h:
 *
 * Common macros and utilities included by every other public header
 */

//

#ifndef ASDF_UTIL_H
#define ASDF_UTIL_H

#include <asdf/config.h> // IWYU pragma: export

#if defined(__clang__) || (defined(__GNUC__) && __GNUC__ >= 4)
#define ASDF_EXPORT __attribute__((visibility("default")))
#define ASDF_LOCAL __attribute__((visibility("hidden")))
#else
#define ASDF_EXPORT
#define ASDF_LOCAL
#endif


#ifdef __cplusplus
#define ASDF_BEGIN_DECLS extern "C" {
#define ASDF_END_DECLS }
#define ASDF_STATIC_ASSERT(cond, msg) static_assert(cond, msg)
#else
#define ASDF_BEGIN_DECLS
#define ASDF_END_DECLS
#define ASDF_STATIC_ASSERT(cond, msg) _Static_assert(cond, msg)
#endif


/* AFAIK this should be supported on virtually any target/compiler */
#define ASDF_CONSTRUCTOR __attribute__((constructor))
#define ASDF_DESTRUCTOR __attribute__((destructor))


ASDF_BEGIN_DECLS

/**
 * Free a buffer that libasdf allocated on the caller's behalf
 *
 * Use this for buffers returned by `asdf_write_to_mem`,
 * `asdf_ndarray_read_all`, `asdf_ndarray_read_tile_ndim` and
 * `asdf_ndarray_read_tile_2d` when they were asked to allocate the
 * destination buffer.  Other pointers returned by libasdf have their own
 * destructors and must not be passed here.
 *
 * :param buf: The buffer to free; passing `NULL` is a no-op
 */
ASDF_EXPORT void asdf_free(void *buf);

ASDF_END_DECLS


#endif /* ASDF_UTIL_H */