tailfeather 0.3.0

Allocation-free, transport-agnostic building blocks for a Tailscale-compatible mesh node
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

//! Allocation-free protocol components and a cooperative mesh [`Node`].
//!
//! The protocol modules are public so applications can use the individual
//! codecs, while [`Node`] is the preferred integration boundary. `Node` owns
//! protocol state but no sockets, executor, clock, random source, or storage.
//!
//! ```
//! use tailfeather::{Node, keys::{Identity, Rng}};
//!
//! struct Fixed;
//! impl Rng for Fixed {
//!     fn fill_bytes(&mut self, out: &mut [u8]) { out.fill(7); }
//! }
//!
//! let identity = Identity::generate(&mut Fixed);
//! let node = Node::<4>::factory_reset(identity, 1);
//! assert!(node.requires_persistence());
//! ```

#![no_std]
#![forbid(unsafe_code)]

// Platform adapters must implement these exact trait/crate instances. Public
// reexports prevent Bazel module consumers from accidentally linking a second
// Cargo-universe copy whose types (and feature set) differ.
pub use critical_section;
pub use embedded_io_async;
pub use embedded_tls;

#[cfg(test)]
extern crate std;

pub mod control;
pub mod derp;
pub mod disco;
pub mod keys;
pub mod local_tcp;
pub mod netmap;
pub mod node;
pub mod noise;
pub mod state;
pub mod stun;
pub mod time;

mod unicode_normalization;

pub use micro_h2 as http2;
pub use node::{
    ControlCommand, ControlEvent, ControlSession, DerpCommand, DerpEvent, DerpSession, Endpoint,
    Node, NodeAction, NodeError, NodeStatus, PersistState, RegistrationState, SecretBuffer,
    Transport,
};
pub use wirefeather as tunnel;
/// Bounded storage for netmap collections: inline without `alloc`, growing on
/// the heap (fallibly) with it.
pub use wirefeather::peer_vec::BoundedVec;
/// A `PEERS` bound with no limit: tables grow while memory allows. Requires
/// the `alloc` feature.
pub use wirefeather::peer_vec::UNBOUNDED;