Struct tor_circmgr::build::CircuitBuilder

source · [−]

pub struct CircuitBuilder<R: Runtime> { /* private fields */ }

Expand description

A factory object to build circuits.

A CircuitBuilder holds references to all the objects that are needed to build circuits correctly.

In general, you should not need to construct or use this object yourself, unless you are choosing your own paths.

Implementations

source

impl<R: Runtime> CircuitBuilder<R>

source

pub fn update_network_parameters(&self, p: &NetParameters)

Reconfigure this builder using the latest set of network parameters.

(NOTE: for now, this only affects circuit timeout estimation.)

source

pub async fn build(
 &self,
 path: &TorPath<'_>,
 params: &CircParameters
) -> Result<ClientCirc>

Try to construct a new circuit from a given path, using appropriate timeouts.

This circuit is not automatically registered with any circuit manager; if you don’t hang on it it, it will automatically go away when the last reference is dropped.

Auto Trait Implementations

impl<R> !RefUnwindSafe for CircuitBuilder<R>

impl<R> Send for CircuitBuilder<R>

impl<R> Sync for CircuitBuilder<R>

impl<R> Unpin for CircuitBuilder<R> where
R: Unpin,

impl<R> !UnwindSafe for CircuitBuilder<R>

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for T where
T: Any,

source

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

source

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> DowncastSync for T where
T: Any + Send + Sync,

source

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more