#[non_exhaustive]pub struct TorClientConfig { /* private fields */ }
Expand description
A configuration used to bootstrap a TorClient
.
In order to connect to the Tor network, Arti needs to know a few
well-known directory caches on the network, and the public keys of the
network’s directory authorities. It also needs a place on disk to
store persistent state and cached directory information. (See StorageConfig
for default directories.)
Most users will create a TorClientConfig by running
TorClientConfig::default
.
If you need to override the locations where Arti stores its
information, you can make a TorClientConfig with
TorClientConfigBuilder::from_directories
.
Finally, you can get fine-grained control over the members of a a
TorClientConfig using TorClientConfigBuilder
.
Implementations§
Source§impl TorClientConfig
impl TorClientConfig
Sourcepub fn builder() -> TorClientConfigBuilder
pub fn builder() -> TorClientConfigBuilder
Returns a fresh, default, builder
Source§impl TorClientConfig
impl TorClientConfig
Sourcepub fn dir_mgr_config(&self) -> Result<DirMgrConfig, ConfigBuildError>
pub fn dir_mgr_config(&self) -> Result<DirMgrConfig, ConfigBuildError>
Try to create a DirMgrConfig corresponding to this object.
Sourcepub fn fs_mistrust(&self) -> &Mistrust
pub fn fs_mistrust(&self) -> &Mistrust
Return a reference to the fs_mistrust::Mistrust
object that we’ll
use to check permissions on files and directories by default.
§Usage notes
In the future, specific files or directories may have stricter or looser
permissions checks applied to them than this default. Callers shouldn’t
use this Mistrust
to predict what Arti will accept for a specific
file or directory. Rather, you should use this if you have some file or
directory of your own on which you’d like to enforce the same rules as
Arti uses.
Sourcepub fn keystore(&self) -> ArtiKeystoreConfig
pub fn keystore(&self) -> ArtiKeystoreConfig
Return the keystore config
Sourcepub fn system_memory(&self) -> &Config
Available on crate feature testing
only.
pub fn system_memory(&self) -> &Config
testing
only.Access the tor_memquota
configuration
Ad-hoc accessor for testing purposes.
(ideally we’d use visibility
to make fields pub
, but that doesn’t work.)
Trait Implementations§
Source§impl AsRef<[BridgeConfig]> for TorClientConfig
impl AsRef<[BridgeConfig]> for TorClientConfig
Source§fn as_ref(&self) -> &[BridgeConfig]
fn as_ref(&self) -> &[BridgeConfig]
Source§impl AsRef<BridgesConfig> for TorClientConfig
impl AsRef<BridgesConfig> for TorClientConfig
Source§fn as_ref(&self) -> &BridgesConfig
fn as_ref(&self) -> &BridgesConfig
Source§impl AsRef<CircuitTiming> for TorClientConfig
impl AsRef<CircuitTiming> for TorClientConfig
Source§fn as_ref(&self) -> &CircuitTiming
fn as_ref(&self) -> &CircuitTiming
Source§impl AsRef<FallbackList> for TorClientConfig
impl AsRef<FallbackList> for TorClientConfig
Source§fn as_ref(&self) -> &FallbackList
fn as_ref(&self) -> &FallbackList
Source§impl AsRef<PathConfig> for TorClientConfig
impl AsRef<PathConfig> for TorClientConfig
Source§fn as_ref(&self) -> &PathConfig
fn as_ref(&self) -> &PathConfig
Source§impl AsRef<PreemptiveCircuitConfig> for TorClientConfig
impl AsRef<PreemptiveCircuitConfig> for TorClientConfig
Source§fn as_ref(&self) -> &PreemptiveCircuitConfig
fn as_ref(&self) -> &PreemptiveCircuitConfig
Source§impl CircMgrConfig for TorClientConfig
impl CircMgrConfig for TorClientConfig
Source§fn vanguard_config(&self) -> &VanguardConfig
fn vanguard_config(&self) -> &VanguardConfig
vanguards
and hs-common
only.Source§fn path_rules(&self) -> &PathConfig
fn path_rules(&self) -> &PathConfig
Source§fn circuit_timing(&self) -> &CircuitTiming
fn circuit_timing(&self) -> &CircuitTiming
Source§fn preemptive_circuits(&self) -> &PreemptiveCircuitConfig
fn preemptive_circuits(&self) -> &PreemptiveCircuitConfig
Source§impl Clone for TorClientConfig
impl Clone for TorClientConfig
Source§fn clone(&self) -> TorClientConfig
fn clone(&self) -> TorClientConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TorClientConfig
impl Debug for TorClientConfig
Source§impl Default for TorClientConfig
impl Default for TorClientConfig
Source§impl GuardMgrConfig for TorClientConfig
impl GuardMgrConfig for TorClientConfig
Source§fn bridges_enabled(&self) -> bool
fn bridges_enabled(&self) -> bool
Source§fn fallbacks(&self) -> &FallbackList
fn fallbacks(&self) -> &FallbackList
Source§fn bridges(&self) -> &[BridgeConfig]
fn bridges(&self) -> &[BridgeConfig]
Source§impl HsCircPoolConfig for TorClientConfig
Available on crate features onion-service-client
or onion-service-service
only.
impl HsCircPoolConfig for TorClientConfig
onion-service-client
or onion-service-service
only.Source§fn vanguard_config(&self) -> &VanguardConfig
fn vanguard_config(&self) -> &VanguardConfig
vanguards
and hs-common
only.Source§impl HsClientConnectorConfig for TorClientConfig
Available on crate feature onion-service-client
only.
impl HsClientConnectorConfig for TorClientConfig
onion-service-client
only.Source§fn circuit_timing(&self) -> &CircuitTiming
fn circuit_timing(&self) -> &CircuitTiming
Source§impl PartialEq for TorClientConfig
impl PartialEq for TorClientConfig
Source§impl TopLevel for TorClientConfig
impl TopLevel for TorClientConfig
Source§const DEPRECATED_KEYS: &'static [&'static str] = _
const DEPRECATED_KEYS: &'static [&'static str] = _
impl Eq for TorClientConfig
impl StructuralPartialEq for TorClientConfig
Auto Trait Implementations§
impl Freeze for TorClientConfig
impl RefUnwindSafe for TorClientConfig
impl Send for TorClientConfig
impl Sync for TorClientConfig
impl Unpin for TorClientConfig
impl UnwindSafe for TorClientConfig
Blanket Implementations§
§impl<A, T> AsBits<T> for A
impl<A, T> AsBits<T> for A
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§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<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§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.Source§impl<T> Resolvable for T
impl<T> Resolvable for T
Source§fn resolve(input: &mut ResolveContext) -> Result<T, ConfigResolveError>
fn resolve(input: &mut ResolveContext) -> Result<T, ConfigResolveError>
§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.