Struct CircParameters

#[non_exhaustive]
pub struct CircParameters {
    pub extend_by_ed25519_id: bool,
    pub ccontrol: CongestionControlParams,
    pub n_incoming_cells_permitted: Option<u32>,
    pub n_outgoing_cells_permitted: Option<u32>,
}

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

This type describes rules derived from the consensus, and possibly amended by our own configuration.

Typically, this type created once for an entire circuit, and any special per-hop information is derived from each hop as a CircTarget. Note however that callers may provide different CircParameters for different hops within a circuit if they have some reason to do so, so we do not enforce that every hop in a circuit has the same CircParameters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

extend_by_ed25519_id: bool

Whether we should include ed25519 identities when we send EXTEND2 cells.

ccontrol: CongestionControlParams

Congestion control parameters for this circuit.

n_incoming_cells_permitted: Option<u32>

Maximum number of permitted incoming relay cells for each hop.

If we would receive more relay cells than this from a single hop, we close the circuit with ExcessInboundCells.

If this value is None, then there is no limit to the number of inbound cells.

Known limitation: If this value if u32::MAX, then a limit of u32::MAX - 1 is enforced.

n_outgoing_cells_permitted: Option<u32>

Maximum number of permitted outgoing relay cells for each hop.

If we would try to send more relay cells than this from a single hop, we close the circuit with ExcessOutboundCells. It is the circuit-user’s responsibility to make sure that this does not happen.

This setting is used to ensure that we do not violate a limit imposed by n_incoming_cells_permitted on the other side of a circuit.

If this value is None, then there is no limit to the number of outbound cells.

Known limitation: If this value if u32::MAX, then a limit of u32::MAX - 1 is enforced.

Implementations

impl CircParameters

pub fn new( extend_by_ed25519_id: bool, ccontrol: CongestionControlParams, ) -> Self

Constructor

Trait Implementations

impl Clone for CircParameters

fn clone(&self) -> CircParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CircParameters

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

Formats the value using the given formatter.