seasick 0.2.1

FFI-safe nul-terminated strings with ownership semantics
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

<!-- cargo-rdme start -->

FFI-safe types for writing and transcribing C APIs.

[`&CStr`] and [`CString`] are not FFI safe.
```rust
#[deny(improper_ctypes)]
extern "C" {
    fn concat(_: &CStr, _: &CStr) -> CString;
}
```
[`&SeaStr`] and [`SeaString`] are FFI-safe equivalents.
```rust
extern "C" {
    fn concat(_: &SeaStr, _: &SeaStr) -> SeaString;
}
```
They use the non-null niche which is filled by [`Option::None`].
```c
/** may return null */
char *foo(void);
```
```rust
extern "C" fn foo() -> Option<SeaString> { .. }
assert_eq!(size_of::<Option<SeaString>>(), size_of::<*mut c_char>());
```

[`SeaBox`] is an additional owned pointer type, with a pluggable [`Allocator`].

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

<!-- cargo-rdme end -->