hibana 0.8.0

Const-projected Affine Multiparty Session Types for choreography-first Rust protocols
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

//! Protocol-neutral integration surface for protocol implementors.
//!
//! App code should not use this module directly. Protocol crates use it to
//! project a choreography, allocate runtime storage, bind transport I/O, and
//! return an attached [`crate::Endpoint`].
//!
//! The canonical integration path is:
//!
//! ```text
//! g choreography
//!   -> integration::program::project(&program)
//!   -> integration::runtime::Config
//!   -> SessionKitStorage::uninit().init()
//!   -> kit.rendezvous(...)
//!   -> registered rendezvous .session(...).role(...)
//!   -> role witness `.enter()`
//!   -> Endpoint
//! ```
//!
//! The everyday owners are:
//!
//! - [`integration::program`](crate::integration::program) for projection and
//!   role-local witnesses;
//! - [`integration::runtime`](crate::integration::runtime) for caller-provided
//!   buffers and clocks;
//! - [`integration::binding`](crate::integration::binding) for optional
//!   demux/channel evidence;
//! - [`integration::wire`](crate::integration::wire) for payload codecs;
//! - [`integration::transport`](crate::integration::transport) and
//!   [`integration::transport::Transport`] for I/O readiness;
//! - [`integration::policy`](crate::integration::policy) for explicit
//!   resolver-backed dynamic policy;
//! - [`integration::cap`](crate::integration::cap) for protocol-neutral control
//!   tokens.
//!
//! Transport observation and control-kind catalogues stay under their owning
//! canonical buckets; the integration surface does not expose parallel
//! mirrors.
//!
//! Integration APIs surface attach and resolver failures as domain-specific
//! evidence. They do not add a public timeout, cancellation, restart helper, or
//! wide `HibanaError` layer; any fresh attempt is an integration decision that
//! starts a new session generation.
//!
//! # Unsafe Owner Contract
//!
//! This module owns host-facing in-place construction. Unsafe operations are
//! limited to initializing caller-provided storage, reborrowing that
//! initialized kit for the guard lifetime, and dropping it exactly once through
//! the storage owner.

pub use crate::control::cluster::error::AttachError;

mod buckets;
mod fluent;
mod session_kit;
#[cfg(all(test, hibana_repo_tests, feature = "std"))]
mod tests;

pub use buckets::*;
pub use session_kit::{RendezvousKit, RoleKit, SessionKit, SessionKitStorage};