Struct OnionCircuitProtocol 

pub struct OnionCircuitProtocol { /* private fields */ }

Encrypted onion circuit protocol.

Implementations

impl OnionCircuitProtocol

pub fn new(capabilities: OnionCircuitCapabilities) -> Self

Create a protocol instance over explicit onion circuit capabilities.

Trait Implementations

impl Clone for OnionCircuitProtocol

fn clone(&self) -> OnionCircuitProtocol

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OnionCircuitProtocol

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Protocol for OnionCircuitProtocol

type State = OnionCircuitState

Protocol-private state, owned by the runtime and threaded through step.

type Event = OnionCircuitEvent

The protocol’s typed input, produced by decode.

type Effect = OnionCircuitEffect

The protocol’s own effect algebra (the core defines no global effect enum).

fn namespace(&self) -> &str

The namespace this protocol is registered and routed under.

fn init(&self) -> Self::State

Initial state. init : 1 → S.

fn decode(&self, wire: Wire<'_>) -> Result<Self::Event, Reject>

Decode the boundary into a typed event, or Reject it. decode : Wire ⇀ Event.

fn step( &self, ctx: Ctx<'_, Self::State>, event: Self::Event, ) -> Transition<Self::State, Self::Effect>

Pure transition. step : (Ctx S, Event) → Transition (S, Effect).

fn capabilities(&self) -> &'static [&'static str]

Optional online-node capability labels advertised when this protocol is registered.