4 releases

0.5.3 Aug 21, 2022
0.5.2 Aug 9, 2022
0.5.1 Nov 29, 2020
0.5.0 Nov 29, 2020

#186 in FFI

Download history 20/week @ 2024-02-19 39/week @ 2024-02-26 18/week @ 2024-03-04 19/week @ 2024-03-11 15/week @ 2024-03-18 20/week @ 2024-03-25 37/week @ 2024-04-01

96 downloads per month
Used in 5 crates

Apache-2.0 OR MIT

16KB
85 lines

abibool - C ABI compatible boolean types

GitHub crates.io docs.rs License Build Status

For most sane rust APIs, you should prefer bool in your interfaces and simply convert between types. However, bool isn't legal for all bit patterns, making it unusable for most FFI without conversions. For simple FFI, this isn't a problem, but C APIs writing arrays of BOOL or BOOLEAN, or structures containing these types, become problematic and require allocations and copies to avoid undefined behavior. Alternatively, you could just use integer types, that can obfuscate intent and result in bugs if multiple truthy-but-different value are directly compared when you expect boolean logic.

Type Map

Note that this is incredibly system specific. E.g. BOOL for windows is 4 bytes, but for OS X it's 1 byte... probably.
When using abibool to write FFI crates, you may wish to cc a bunch of static_asserts in a build script to validate the size of your underlying C types.

C / C++ type abibool type notes
bool (C++) varies Often 1 byte, but sometimes 4 or worse
_Bool (C99 / stdbool.h) varies Often 1 byte, but sometimes 4 or worse
BOOLEAN (Win32) b8 / bool8
BOOL (Win32) b32 / bool32
BOOL (OS X / objc.h) b8 / bool8 ? Typically signed char, but sometimes bool or unsigned char
jboolean (Java / JNI) b8 / bool8

References

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~33KB