Struct arti_client::config::circ::PreemptiveCircuitConfigBuilder

pub struct PreemptiveCircuitConfigBuilder { /* private fields */ }

Builder for PreemptiveCircuitConfig.

Implementations

impl PreemptiveCircuitConfigBuilder

pub fn disable_at_threshold(
    &mut self,
    value: usize
) -> &mut PreemptiveCircuitConfigBuilder

If we have at least this many available circuits, we suspend construction of preemptive circuits. whether our available circuits support our predicted exit ports or not.

pub fn prediction_lifetime(
    &mut self,
    value: Duration
) -> &mut PreemptiveCircuitConfigBuilder

After we see the client request a connection to a new port, how long should we predict that the client will still want to have circuits available for that port?

pub fn min_exit_circs_for_port(
    &mut self,
    value: usize
) -> &mut PreemptiveCircuitConfigBuilder

How many available circuits should we try to have, at minimum, for each predicted exit port?

pub fn build(&self) -> Result<PreemptiveCircuitConfig, ConfigBuildError>

Builds a new PreemptiveCircuitConfig.

Errors

If a required field has not been initialized.

impl PreemptiveCircuitConfigBuilder

pub fn initial_predicted_ports(&mut self) -> &mut Vec<u16, Global>

At startup, which exit ports should we expect that the client will want? (accessor).

(Over time, new ports are added to the predicted list, in response to what the client has actually requested.)

This value cannot be changed on a running Arti client, because doing so would be meaningless.

The default is [80, 443].

Mutable accessor

This method access the being-built list initial_predicted_ports (resolving the default first).

If the field has not yet been set or accessed, the default list will be constructed and a mutable reference to the now-defaulted list of builders will be returned.

pub fn set_initial_predicted_ports(&mut self, list: Vec<u16, Global>)

At startup, which exit ports should we expect that the client will want? (setter).

(Over time, new ports are added to the predicted list, in response to what the client has actually requested.)

This value cannot be changed on a running Arti client, because doing so would be meaningless.

The default is [80, 443].

Setter

This method replaces the whole being-built list initial_predicted_ports.

This overrides the default, and also overrides any previous settings.

pub fn opt_initial_predicted_ports(&self) -> &Option<Vec<u16, Global>>

At startup, which exit ports should we expect that the client will want? (inspector, Option).

(Over time, new ports are added to the predicted list, in response to what the client has actually requested.)

This value cannot be changed on a running Arti client, because doing so would be meaningless.

The default is [80, 443].

Inspector (default-aware, involving Option)

This method inspects the being-built list initial_predicted_ports (with default unresolved).

If the list has not yet been set, or accessed, &None is returned.

pub fn opt_initial_predicted_ports_mut(
    &mut self
) -> &mut Option<Vec<u16, Global>>

At startup, which exit ports should we expect that the client will want? (accessor, Option).

(Over time, new ports are added to the predicted list, in response to what the client has actually requested.)

This value cannot be changed on a running Arti client, because doing so would be meaningless.

The default is [80, 443].

Mutable accessor (default-aware, involving Option)

This method mutably accesses the being-built list initial_predicted_ports (with default unresolved).

None represents the use of the default value: If the list has not yet been set, or accessed, &mut None is returned. Assigning None will undo any previous settings and arrange for the default value to be used when the field value is resolved,

Trait Implementations

impl Builder for PreemptiveCircuitConfigBuilder

type Built = PreemptiveCircuitConfig

The type that this builder constructs

fn build(&self) -> Result<PreemptiveCircuitConfig, ConfigBuildError>

Build into a Built

impl Clone for PreemptiveCircuitConfigBuilder

fn clone(&self) -> PreemptiveCircuitConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PreemptiveCircuitConfigBuilder

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

Formats the value using the given formatter.

impl Default for PreemptiveCircuitConfigBuilder

fn default() -> PreemptiveCircuitConfigBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PreemptiveCircuitConfigBuilder

fn deserialize<__D>(
    __deserializer: __D
) -> Result<PreemptiveCircuitConfigBuilder, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for PreemptiveCircuitConfigBuilder

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.