Struct tor_circmgr::build::CircuitBuilder
source · pub struct CircuitBuilder<R: Runtime> {
builder: Arc<Builder<R, ClientCirc>>,
path_config: MutCfg<PathConfig>,
storage: DynStorageHandle<ParetoTimeoutState>,
guardmgr: GuardMgr<R>,
vanguardmgr: Arc<VanguardMgr<R>>,
}
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.
Fields§
§builder: Arc<Builder<R, ClientCirc>>
The underlying Builder
object
path_config: MutCfg<PathConfig>
Configuration for how to choose paths for circuits.
storage: DynStorageHandle<ParetoTimeoutState>
State-manager object to use in storing current state.
guardmgr: GuardMgr<R>
Guard manager to tell us which guards nodes to use for the circuits we build.
vanguardmgr: Arc<VanguardMgr<R>>
vanguards
and hs-common
only.The vanguard manager object used for HS circuits.
Implementations§
source§impl<R: Runtime> CircuitBuilder<R>
impl<R: Runtime> CircuitBuilder<R>
sourcepub(crate) fn new(
runtime: R,
chanmgr: Arc<ChanMgr<R>>,
path_config: PathConfig,
storage: DynStorageHandle<ParetoTimeoutState>,
guardmgr: GuardMgr<R>,
vanguardmgr: VanguardMgr<R>
) -> Self
pub(crate) fn new( runtime: R, chanmgr: Arc<ChanMgr<R>>, path_config: PathConfig, storage: DynStorageHandle<ParetoTimeoutState>, guardmgr: GuardMgr<R>, vanguardmgr: VanguardMgr<R> ) -> Self
Construct a new CircuitBuilder
.
sourcepub(crate) fn path_config(&self) -> Arc<PathConfig>
pub(crate) fn path_config(&self) -> Arc<PathConfig>
Return this builder’s PathConfig
.
sourcepub(crate) fn set_path_config(&self, new_config: PathConfig)
pub(crate) fn set_path_config(&self, new_config: PathConfig)
Replace this builder’s PathConfig
.
sourcepub(crate) fn save_state(&self) -> Result<bool>
pub(crate) fn save_state(&self) -> Result<bool>
Flush state to the state manager if we own the lock.
Return Ok(true)
if we saved, and Ok(false)
if we didn’t hold the lock.
sourcepub(crate) fn upgrade_to_owned_state(&self) -> Result<()>
pub(crate) fn upgrade_to_owned_state(&self) -> Result<()>
Replace our state with a new owning state, assuming we have storage permission.
sourcepub(crate) fn reload_state(&self) -> Result<()>
pub(crate) fn reload_state(&self) -> Result<()>
Reload persistent state from disk, if we don’t have storage permission.
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(crate) async fn build_owned(
&self,
path: OwnedPath,
params: &CircParameters,
guard_status: Arc<GuardStatusHandle>,
usage: ChannelUsage
) -> Result<Arc<ClientCirc>>
pub(crate) async fn build_owned( &self, path: OwnedPath, params: &CircParameters, guard_status: Arc<GuardStatusHandle>, usage: ChannelUsage ) -> Result<Arc<ClientCirc>>
Like build
, but construct a new circuit from an OwnedPath
.
sourcepub async fn build(
&self,
path: &TorPath<'_>,
params: &CircParameters,
usage: ChannelUsage
) -> Result<Arc<ClientCirc>>
pub async fn build( &self, path: &TorPath<'_>, params: &CircParameters, usage: ChannelUsage ) -> Result<Arc<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.
sourcepub(crate) fn learning_timeouts(&self) -> bool
pub(crate) fn learning_timeouts(&self) -> bool
Return true if this builder is currently learning timeout info.
sourcepub(crate) fn vanguardmgr(&self) -> &Arc<VanguardMgr<R>>
Available on crate features vanguards
and hs-common
only.
pub(crate) fn vanguardmgr(&self) -> &Arc<VanguardMgr<R>>
vanguards
and hs-common
only.Return a reference to this builder’s VanguardMgr
.
Trait Implementations§
source§impl<R: Runtime> AbstractCircBuilder for CircuitBuilder<R>
impl<R: Runtime> AbstractCircBuilder for CircuitBuilder<R>
§type Spec = SupportedCircUsage
type Spec = SupportedCircUsage
§type Plan = Plan
type Plan = Plan
source§fn plan_circuit(
&self,
usage: &TargetCircUsage,
dir: DirInfo<'_>
) -> Result<(Plan, SupportedCircUsage)>
fn plan_circuit( &self, usage: &TargetCircUsage, dir: DirInfo<'_> ) -> Result<(Plan, SupportedCircUsage)>
usage
. Read moresource§fn build_circuit<'life0, 'async_trait>(
&'life0 self,
plan: Plan
) -> Pin<Box<dyn Future<Output = Result<(SupportedCircUsage, Arc<ClientCirc>)>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn build_circuit<'life0, 'async_trait>(
&'life0 self,
plan: Plan
) -> Pin<Box<dyn Future<Output = Result<(SupportedCircUsage, Arc<ClientCirc>)>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
source§fn launch_parallelism(&self, spec: &TargetCircUsage) -> usize
fn launch_parallelism(&self, spec: &TargetCircUsage) -> usize
source§fn select_parallelism(&self, spec: &TargetCircUsage) -> usize
fn select_parallelism(&self, spec: &TargetCircUsage) -> usize
source§fn learning_timeouts(&self) -> bool
fn learning_timeouts(&self) -> bool
Auto Trait Implementations§
impl<R> !Freeze for CircuitBuilder<R>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.