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

//! Localside endpoint facade.
//!
//! An [`Endpoint`] is the app-facing affine executor for one projected role. It
//! is created by [`crate::integration::SessionKit`] and then advanced with the
//! four localside operations: [`Endpoint::flow`], [`Endpoint::recv`],
//! [`Endpoint::offer`], and [`RouteBranch::decode`].
//!
//! `flow` and `offer` are non-consuming previews. Committed progress happens
//! when a send, receive, or route decode succeeds. Committed endpoint failures
//! return [`EndpointError`] as diagnostic evidence and poison the current
//! session generation; they do not authorize hidden alternate progress.
//!
//! # Unsafe Owner Contract
//!
//! This module owns only the app-facing raw future and route-branch handles.
//! Unsafe operations dereference the carrier header installed by the rendezvous
//! endpoint owner; the endpoint borrow guarantees exclusive localside access,
//! and every raw future either completes, restores preview state, or fails fast
//! on post-ready reuse.

/// Affine endpoint helpers.
pub(crate) mod affine;
mod branch;
/// Crate-private carrier owners for internal endpoint type packs.
pub(crate) mod carrier;
/// Control-plane helpers for endpoints.
pub(crate) mod control;
mod error;
/// Flow-based send API.
pub(crate) mod flow;
mod futures;
/// Internal endpoint kernel implementation.
pub(crate) mod kernel;
mod ops;
mod public_types;
#[cfg(all(test, hibana_repo_tests))]
mod tests;

pub use self::error::{EndpointError, EndpointResult};
pub(crate) use self::error::{
    EndpointOp, ErrorLocation, RecvError, RecvResult, SendError, SendResult,
};
pub use self::flow::Flow;
pub(crate) use self::futures::RecvFuture;
pub use self::public_types::{Endpoint, RouteBranch};