Struct OnionConfig 

pub struct OnionConfig { /* private fields */ }

Configuration for publishing a Tor .onion hidden service via Server::serve_onion/Server::serve_onion_with_client.

See the module docs for a full example.

Implementations

impl OnionConfig

pub fn new(nickname: impl Into<String>) -> Self

Creates a new configuration for a service published under nickname.

Defaults: TLS enabled with a self-signed certificate if the cert-gen feature is enabled (virtual port 443, alongside plaintext on virtual port 80 — see redirect_http); plaintext-only otherwise (or always, if the tls feature isn’t enabled at all — see the module docs). No forced HTTP→HTTPS redirect, and vanguards on — see vanguards to change it. nickname is validated (as an HsNickname) when the service is actually launched.

pub fn state_dir(self, dir: impl Into<PathBuf>) -> Self

Overrides the directory Arti uses for persistent state — including this service’s onion keys. Reusing the same directory (and nickname) across restarts keeps the same .onion address. Defaults to Arti’s own platform-specific state directory.

pub fn cache_dir(self, dir: impl Into<PathBuf>) -> Self

Overrides the directory Arti uses for cached network directory information. Defaults to Arti’s own platform-specific cache directory.

pub fn no_tls(self) -> Self

Disables HTTPS entirely — only plaintext HTTP on virtual port 80 is served, matching Server::serve_tor.

pub fn self_signed_tls(self) -> Self

Re-enables HTTPS with a freshly generated self-signed certificate (the default when this feature is available), after a prior no_tls or tls_config call. Requires the cert-gen feature.

pub fn tls_config(self, config: ServerConfig) -> Self

Enables HTTPS using a caller-supplied rustls::ServerConfig instead of the default self-signed certificate — for example, the exact same config passed to Server::serve_https_config for the clearnet listener, so a custom crypto provider, FIPS constraints, or a real cert chain carry over unchanged. Requires the tls feature.

pub const fn redirect_http(self, enable: bool) -> Self

Controls what happens to plaintext HTTP (virtual port 80) requests when TLS is enabled.

false (the default): plaintext and TLS are both served — a dual-stack onion service, same as browsing a clearnet site over either http:// or https://. true: port 80 instead issues a 308 Permanent Redirect to the equivalent https:// URL, forcing all traffic onto TLS. Has no effect when TLS is disabled (no_tls) or the tls feature isn’t enabled.

pub const fn vanguards(self, enabled: bool) -> Self

Controls whether vanguards are used for this service. Defaults to true.

pub fn on_ready(self, f: impl FnOnce(&str) + Send + 'static) -> Self

Registers a callback invoked exactly once — with the published .onion address (no scheme, e.g. "abcd...xyz.onion") — as soon as the service is fully reachable, just before requests start being served. This is the only way to observe the address programmatically, since serve_onion blocks for the lifetime of the service; the address is also always logged via tracing at info level.

pub fn nickname(&self) -> &str

The nickname this service will be published under.

pub const fn tls_enabled(&self) -> bool

Whether HTTPS is enabled (via the default self-signed cert or a custom tls_config) — false after no_tls, and always false when the tls feature isn’t enabled.

pub const fn redirect_http_enabled(&self) -> bool

Whether plaintext HTTP is forced to redirect to HTTPS — see redirect_http.

pub const fn vanguards_enabled(&self) -> bool

Whether vanguards will be requested for this service — see vanguards.

Trait Implementations

impl Debug for OnionConfig

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

Formats the value using the given formatter.