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
sourceimpl<R: Runtime> CircuitBuilder<R>
impl<R: Runtime> CircuitBuilder<R>
sourcepub fn update_network_parameters(&self, p: &NetParameters)
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.)
sourcepub async fn build(
&self,
path: &TorPath<'_>,
params: &CircParameters
) -> Result<ClientCirc>
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more