native-ipc-core 0.6.1

Platform-neutral, pointer-free protocol and sequencing primitives for native-ipc
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

# native-ipc-core

Platform-neutral, pointer-free wire formats, checked shared-memory layouts,
publication sequencing, and mapping-owned reader/writer bindings for
[`native-ipc`](https://crates.io/crates/native-ipc).

This crate is useful when implementing a custom transport or protocol. Most
applications should depend on `native-ipc`, which combines these primitives
with native capability enforcement.

## Main modules

- [`codec`](https://docs.rs/native-ipc-core/latest/native_ipc_core/codec/):
  fixed-width envelopes, bounded decoding, and protocol traits.
- [`layout`](https://docs.rs/native-ipc-core/latest/native_ipc_core/layout/):
  canonical multi-region layouts and hostile-memory validation.
- [`mapping`](https://docs.rs/native-ipc-core/latest/native_ipc_core/mapping/):
  mapping-owned runtime regions that prevent duplicate safe writer binding.
- [`slot`](https://docs.rs/native-ipc-core/latest/native_ipc_core/slot/):
  release/acquire publication, snapshot rechecks, and acknowledgements.

## Layout example

```rust
use native_ipc_core::layout::{
    AcknowledgementRouteSpec, Endpoint, LayoutLimits, RegionSetLayout,
    RegionSpec, RoleId,
};

let producer = RoleId::new(1).unwrap();
let peer = RoleId::new(2).unwrap();
let regions = [
    RegionSpec {
        role: producer,
        writer: Endpoint::Initiator,
        slot_count: 1,
        payload_bytes: 256,
        acknowledgement_count: 1,
    },
    RegionSpec {
        role: peer,
        writer: Endpoint::Responder,
        slot_count: 1,
        payload_bytes: 256,
        acknowledgement_count: 1,
    },
];
let routes = [
    AcknowledgementRouteSpec {
        owner: peer,
        target: producer,
        slot_index: 0,
        cell_index: 0,
    },
    AcknowledgementRouteSpec {
        owner: producer,
        target: peer,
        slot_index: 0,
        cell_index: 0,
    },
];
let topology = RegionSetLayout::calculate(
    [0x52; 32],
    1,
    &regions,
    &routes,
    LayoutLimits {
        maximum_mapping_size: 64 * 1024,
        maximum_slot_count: 8,
        maximum_acknowledgement_count: 8,
        maximum_payload_bytes: 4096,
    },
)?;
assert_eq!(topology.region(producer).unwrap().slot_count(), 1);
# Ok::<(), native_ipc_core::layout::LayoutError>(())
```

Complete examples:

- [checked multi-region layout](https://github.com/ro-ag/native-ipc-rs/blob/main/crates/native-ipc-core/examples/checked_layout.rs)
- [bounded message codec](https://github.com/ro-ag/native-ipc-rs/blob/main/crates/native-ipc-core/examples/bounded_codec.rs)

The crate supports `no_std` with allocation by disabling the default `std`
feature.

Licensed under MIT or Apache-2.0.