Module circuit 

Circuit-related types and helpers.

This code is shared between the client and relay implementations.

Re-exports

pub use crate::memquota::StreamAccount;

Modules

cell_sender 🔒

Implements an outbound Sink type for cells being sent from a circuit onto a channel.

celltypes 🔒

Wrapper types for subsets of ChanMsg and RelayMsg types.

circhop 🔒

Module exposing structures relating to a reactor’s view of a circuit hop.

syncview 🔒

Implement synchronous views of circuit internals.

unique_id 🔒

Unique identifiers for circuits.

Structs

CircParameters

Description of the network’s current rules for building circuits.

CircSyncView

An object that represents a view of a circuit’s internals, usable in a synchronous callback.

UniqId

Process-unique identifier for a circuit.

Type Aliases

CircuitRxReceiver 🔒

MPSC queue for inbound data on its way from channel to circuit, receiver

CircuitRxSender 🔒

The following two MPSCs take any channel message as the receiving end can be either a client or a relay circuit reactor. The reactor itself will convert into its restricted message set. On error, the circuit will shutdown as it will be considered a protocol violation.