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

/// App-facing affine executor for a projected role.
///
/// The endpoint is intentionally local-only and moves forward one descriptor
/// step at a time. Successful sends, receives, and route decodes consume
/// progress. Dropped send/route previews restore the endpoint to its previous
/// step. Once a committed fault is observed, the same session generation cannot
/// produce a new continuation.
pub struct Endpoint<'r, const ROLE: u8> {
    pub(super) ptr: core::ptr::NonNull<super::carrier::KernelEndpointHeader<'r>>,
    pub(super) handle: super::carrier::PackedEndpointHandle,
    pub(super) _borrow: core::marker::PhantomData<&'r mut crate::binding::BindingHandle<'r>>,
    pub(super) _local_only: crate::local::LocalOnly,
}

/// Preview of a selected route branch returned by [`Endpoint::offer`].
///
/// `RouteBranch` exposes the selected logical label. If the selected arm begins
/// with a receive, call [`RouteBranch::decode`]. If it begins with a send, drop
/// the branch preview and call [`Endpoint::flow`] for that arm's first message.
/// The label is descriptor/resolver evidence, not the result of parsing payload
/// bytes.
pub struct RouteBranch<'e, 'r, const ROLE: u8> {
    pub(super) endpoint: *mut Endpoint<'r, ROLE>,
    pub(super) label: u8,
    pub(super) _borrow: core::marker::PhantomData<&'e mut Endpoint<'r, ROLE>>,
    pub(super) _local_only: crate::local::LocalOnly,
}