seasick 0.4.4

Tools for implementing and transcribing C APIs.
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

<!-- cargo-rdme start -->

Tools for implementing and transcribing C APIs.

[`&CStr`], [`CString`] and [`Box`] are not FFI safe.

```rust
#[deny(improper_ctypes_definitions)]
extern "C" fn bad(_: &CStr, _: Box<u8>) -> CString { todo!() }
```

[`&SeaStr`], [`SeaString`] and [`SeaBox`] are FFI-safe equivalents.

```rust
#[deny(improper_ctypes_definitions)]
extern "C" fn good(_: &SeaStr, _: SeaBox<u8>) -> SeaString { todo!() }
```

<details><summary>

All are pointer-wide, with a non-null niche filled by [`Option::None`].
</summary>

```rust
assert_eq!(size_of::<SeaBox<u8>>(),         size_of::<*mut u8>());
assert_eq!(size_of::<Option<SeaBox<u8>>>(), size_of::<*mut u8>());
assert_eq!(size_of::<SeaString>(),          size_of::<*mut c_char>());
assert_eq!(size_of::<Option<SeaString>>(),  size_of::<*mut c_char>());
```
</details>

[`trait@TransmuteFrom`] is the culmination of this crate,
for writing your own wrappers to C types.
See its documentation for more.

[`&CStr`]: core::ffi::CStr
[`&SeaStr`]: SeaStr
[`CString`]: alloc::ffi::CString
[`Box`]: alloc::boxed::Box

<!-- cargo-rdme end -->