Struct tor_circmgr::PreemptiveCircuitConfigBuilder

source · [−]

pub struct PreemptiveCircuitConfigBuilder { /* private fields */ }

Expand description

Builder for PreemptiveCircuitConfig.

Implementations

impl PreemptiveCircuitConfigBuilder

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

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 initial_predicted_ports(&mut self, value: Vec<u16>) -> &mut Self

At startup, which exit ports should we expect that the client will want?

(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.

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

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 Self

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.

Trait Implementations

impl Clone for PreemptiveCircuitConfigBuilder

fn clone(&self) -> PreemptiveCircuitConfigBuilder

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Default for PreemptiveCircuitConfigBuilder

fn default() -> Self

Returns the “default value” for a type. Read more

impl From<PreemptiveCircuitConfig> for PreemptiveCircuitConfigBuilder

fn from(cfg: PreemptiveCircuitConfig) -> PreemptiveCircuitConfigBuilder

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for PreemptiveCircuitConfigBuilder

impl Send for PreemptiveCircuitConfigBuilder

impl Sync for PreemptiveCircuitConfigBuilder

impl Unpin for PreemptiveCircuitConfigBuilder

impl UnwindSafe for PreemptiveCircuitConfigBuilder

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more