hibana 0.9.3

Session-typed choreographic programming for no_std Rust protocols, inspired by affine MPST
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

//! Localside endpoint facade.
//!
//! An [`Endpoint`] is the app-facing affine executor for one projected role. It
//! is created by [`crate::runtime::SessionKit`] and then advanced with the
//! localside operations: [`Endpoint::send`], [`Endpoint::recv`],
//! [`Endpoint::offer`], [`RouteBranch::send`], and [`RouteBranch::recv`].
//!
//! `offer` is a non-consuming route preview.
//! Committed progress happens when a send, receive, or route branch first-step
//! operation succeeds.
//! Committed endpoint failures return [`EndpointError`] as diagnostic evidence
//! and poison the current session generation; they do not authorize hidden
//! alternate progress.
//! Successful sends, receives, and route branch first-step operations consume
//! progress. Dropped unpolled sends do not publish runtime progress; dropped
//! in-flight sends and route previews restore their resident endpoint state.
//!
//! # 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;
mod error;
mod futures;
/// Endpoint kernel implementation.
pub(crate) mod kernel;
mod ops;
mod public_types;
/// Send future.
pub(crate) mod send;
/// Endpoint session binding helpers.
pub(crate) mod session;
#[cfg(all(test, hibana_repo_tests))]
mod tests;

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