Struct TorConfig 

pub struct TorConfig {
    pub mode: Option<String>,
    pub socks5_addr: Option<String>,
    pub connect_timeout_ms: Option<u64>,
    pub mtu: Option<u16>,
    pub control_addr: Option<String>,
    pub control_auth: Option<String>,
    pub cookie_path: Option<String>,
    pub max_inbound_connections: Option<usize>,
    pub directory_service: Option<DirectoryServiceConfig>,
    pub advertise_on_nostr: Option<bool>,
    pub advertised_port: Option<u16>,
}

Tor transport instance configuration.

Supports three modes:

• socks5: Outbound-only connections through a Tor SOCKS5 proxy.
• control_port: Full bidirectional support — outbound via SOCKS5 plus inbound via Tor onion service managed through the control port.
• directory: Full bidirectional support — outbound via SOCKS5, inbound via a Tor-managed HiddenServiceDir onion service. No control port needed. Enables Tor Sandbox 1 mode.

Fields

mode: Option<String>

Tor access mode: “socks5”, “control_port”, or “directory”. Default: “socks5”.

socks5_addr: Option<String>

SOCKS5 proxy address (host:port). Defaults to “127.0.0.1:9050”.

connect_timeout_ms: Option<u64>

Outbound connect timeout in milliseconds. Defaults to 120000 (120s). Tor circuit establishment can take 30-60s, so this must be generous.

mtu: Option<u16>

Default MTU for Tor connections. Defaults to 1400.

control_addr: Option<String>

Control port address: a Unix socket path (/run/tor/control) or TCP address (host:port). Unix sockets are preferred for security. Defaults to “/run/tor/control”.

control_auth: Option<String>

Control port authentication method: "cookie" (read from default path), "cookie:/path/to/cookie" (read from specified path), or "password:secret" (password auth). Default: "cookie".

cookie_path: Option<String>

Path to the Tor control cookie file. Used when control_auth is “cookie”. Defaults to “/var/run/tor/control.authcookie”.

max_inbound_connections: Option<usize>

Maximum number of inbound connections via onion service. Default: 64.

directory_service: Option<DirectoryServiceConfig>

Directory-mode onion service configuration. Only valid in “directory” mode. Tor manages the onion service via HiddenServiceDir in torrc; fips reads the .onion hostname from a file.

advertise_on_nostr: Option<bool>

Whether this transport should be advertised on Nostr overlay discovery. Default: false.

advertised_port: Option<u16>

Public-facing onion port published in Nostr overlay adverts. Must match the virtual port in torrc’s HiddenServicePort <port> 127.0.0.1:<bind_port> directive — that is the port other peers will use to reach this onion. Default: 443.

Implementations

impl TorConfig

pub fn mode(&self) -> &str

Get the access mode. Default: “socks5”.

pub fn socks5_addr(&self) -> &str

Get the SOCKS5 proxy address. Default: “127.0.0.1:9050”.

pub fn control_addr(&self) -> &str

Get the control port address. Default: “/run/tor/control”.

pub fn control_auth(&self) -> &str

Get the control auth string. Default: “cookie”.

pub fn cookie_path(&self) -> &str

Get the cookie file path. Default: “/var/run/tor/control.authcookie”.

pub fn connect_timeout_ms(&self) -> u64

Get the connect timeout in milliseconds. Default: 120000.

pub fn mtu(&self) -> u16

Get the default MTU. Default: 1400.

pub fn max_inbound_connections(&self) -> usize

Get the max inbound connections. Default: 64.

pub fn advertise_on_nostr(&self) -> bool

Whether this Tor transport should be advertised on Nostr discovery.

pub fn advertised_port(&self) -> u16

Public-facing onion port published in Nostr overlay adverts. Default: 443.

Trait Implementations

impl Clone for TorConfig

fn clone(&self) -> TorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TorConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TorConfig

fn default() -> TorConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TorConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TorConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.