Module client 

A general interface for Tor client usage.

To construct a client, run the TorClient::create_bootstrapped method. Once the client is bootstrapped, you can make anonymous connections (“streams”) over the Tor network using TorClient::connect.

Structs

BootstrapSetting 🔒

A representation of whether a TorClient is allowed to bootstrap, and whether it has begun to do so.

ClientShared 🔒

Shared pieces of a TorClient, used to implement client functionality.

InertTorClient

A Tor client that is not runnable.

NotConstructedInner 🔒

Information stored by a never-bootstrapped TorClient, used to eventually construct a RunningInner and bootstrap.

RunningInner 🔒

Data structures for a “running” client.

StreamPrefs

Preferences for how to route a stream over the Tor network.

TorClient

An active client session on the Tor network.

Enums

BootstrapBehavior

Preferences for whether a TorClient should bootstrap on its own or not.

DormantMode

What level of sleep to put a Tor client into.

Inner 🔒

A typestate object holding the parts of the client state that we may or may not have depending on whether we are running.

StreamIsolationPreference 🔒

Record of how we are isolating connections

Functions

tasks_monitor_dormant 🔒

Monitor dormant_mode and enable/disable periodic tasks as applicable

wrap_err 🔒

Alias for TorError::from(Error)