Struct PreemptiveCircuitConfigBuilder 

pub struct PreemptiveCircuitConfigBuilder {
    disable_at_threshold: Option<usize>,
    initial_predicted_ports: PreemptiveCircuitConfigInitialPredictedPortsListBuilder,
    prediction_lifetime: Option<Duration>,
    min_exit_circs_for_port: Option<usize>,
}

A builder to create an instance of PreemptiveCircuitConfig.

Fields

disable_at_threshold: Option<usize>

initial_predicted_ports: PreemptiveCircuitConfigInitialPredictedPortsListBuilder

prediction_lifetime: Option<Duration>

min_exit_circs_for_port: Option<usize>

Implementations

impl PreemptiveCircuitConfigBuilder

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

Provide a value for disable_at_threshold.

If no value is provided for disable_at_threshold, build will use Default::default().

disable_at_threshold

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, val: Duration, ) -> &mut PreemptiveCircuitConfigBuilder

Provide a value for prediction_lifetime.

If no value is provided for prediction_lifetime, build will use Default::default().

prediction_lifetime

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, val: usize, ) -> &mut PreemptiveCircuitConfigBuilder

Provide a value for min_exit_circs_for_port.

If no value is provided for min_exit_circs_for_port, build will use Default::default().

min_exit_circs_for_port

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

impl PreemptiveCircuitConfigBuilder

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

Access the being-built list (resolving default)

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>)

Set the whole list (overriding the default)

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

Inspect the being-built list (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>>

Mutably access the being-built list (with default unresolved)

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

impl PreemptiveCircuitConfigBuilder

pub fn new() -> PreemptiveCircuitConfigBuilder

Return a new builder object.

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

Try to construct a new PreemptiveCircuitConfig from the fields set in this builder.

Return an error if any required field is missing, or is set to something invalid.

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 duplicate 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 ExtendBuilder for PreemptiveCircuitConfigBuilder

fn extend_from( &mut self, other: PreemptiveCircuitConfigBuilder, strategy: ExtendStrategy, )

Consume other, and merge its contents into self.

impl Flattenable for PreemptiveCircuitConfigBuilder

fn has_field(s: &str) -> bool

Does this type have a field named s ?

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.