Struct arti_client::TorClientBuilder

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

An object for constructing a TorClient.

Returned by TorClient::builder().

Implementations

impl<R: Runtime> TorClientBuilder<R>

pub fn config(self, config: TorClientConfig) -> Self

Set the configuration for the TorClient under construction.

If not called, then a compiled-in default configuration will be used.

pub fn bootstrap_behavior(self, bootstrap_behavior: BootstrapBehavior) -> Self

Set the bootstrap behavior for the TorClient under construction.

If not called, then the default (BootstrapBehavior::OnDemand) will be used.

pub fn disable_fs_permission_checks(self) -> Self

Build an TorClient that will not validate permissions and ownership on the filesystem.

By default, these checks are configured with the storage.permissions field of the configuration, and can be overridden with the ARTI_FS_DISABLE_PERMISSION_CHECKS environment variable.

pub fn ignore_fs_permission_checks_env_var(self) -> Self

Build a TorClient that will follow the permissions checks in the storage.permissions field of the configuration, regardless of how the environment is set.

pub fn obey_fs_permission_checks_env_var(self) -> Self

Build a TorClient that will follow the permissions checks in the storage.permissions field of the configuration, unless the ARTI_FS_DISABLE_PERMISSION_CHECKS environment variable is set.

This is the default.

pub fn dirmgr_builder<B>(self, builder: Arc<dyn DirProviderBuilder<R>>) -> Self where
    B: DirProviderBuilder<R> + 'static, 

Override the default function used to construct the directory provider.

Only available when compiled with the experimental-api feature: this code is unstable.

pub fn dirfilter<F>(self, filter: F) -> Self where
    F: Into<Arc<dyn DirFilter + 'static>>, 

Install a DirFilter to

Only available when compiled with the dirfilter feature: this code is unstable and not recommended for production use.

pub fn create_unbootstrapped(self) -> Result<TorClient<R>>

Create a TorClient from this builder, without automatically launching the bootstrap process.

If you have left the default BootstrapBehavior in place, the client will bootstrap itself as soon any attempt is made to use it. You can also bootstrap the client yourself by running its bootstrap() method.

If you have replaced the default behavior with BootstrapBehavior::Manual, any attempts to use the client will fail with an error of kind ErrorKind::BootstrapRequired, until you have called TorClient::bootstrap yourself.
This option is useful if you wish to have control over the bootstrap process (for example, you might wish to avoid initiating network connections until explicit user confirmation is given).

pub async fn create_bootstrapped(self) -> Result<TorClient<R>>

Create a TorClient from this builder, and try to bootstrap it.

Trait Implementations

impl<R: Clone + Runtime> Clone for TorClientBuilder<R>

fn clone(&self) -> TorClientBuilder<R>

Returns a copy of the value.

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

Performs copy-assignment from source.