Struct OnionProxyConfig 

pub struct OnionProxyConfig {
    pub protocol: OnionProxyProtocol,
    pub hop_count: usize,
    pub allow_short_paths: bool,
    /* private fields */
}

Target-agnostic onion proxy configuration.

A client owns one proxy configuration per ingress style, then resolves one route per target authority. This keeps browser proxy APIs from becoming one-off URL fetch wrappers.

Fields

protocol: OnionProxyProtocol

Requested ingress protocol.

hop_count: usize

Desired hop count including the exit. 0 uses crate::onion::DEFAULT_ONION_ROUTE_HOPS.

allow_short_paths: bool

Whether route selection may use fewer hops when too few relays are live.

Implementations

impl OnionProxyConfig

pub fn new( protocol: OnionProxyProtocol, hop_count: usize, allow_short_paths: bool, ) -> Self

Create a proxy configuration for protocol.

pub fn with_service( protocol: OnionProxyProtocol, service: OnionServiceName, hop_count: usize, allow_short_paths: bool, ) -> Result<Self>

Create a proxy configuration with an explicit exit service.

pub fn tcp_connect(hop_count: usize, allow_short_paths: bool) -> Self

Create a native TCP CONNECT proxy configuration.

pub fn tcp_connect_service( service: OnionServiceName, hop_count: usize, allow_short_paths: bool, ) -> Result<Self>

Create a native TCP CONNECT proxy configuration for a specific TCP exit service.

pub fn https_proxy(hop_count: usize, allow_short_paths: bool) -> Self

Create an HTTPS proxy configuration.

pub fn exit_service(&self) -> &str

Return the onion-exit service name required by this proxy.

pub fn exit_service_name(&self) -> &OnionServiceName

Return the canonical onion-exit service required by this proxy.

pub fn exit_transport(&self) -> OnionExitTransport

Return the onion-exit transport required by this proxy.

Trait Implementations

impl Clone for OnionProxyConfig

fn clone(&self) -> OnionProxyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OnionProxyConfig

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

Formats the value using the given formatter.

impl Eq for OnionProxyConfig

impl PartialEq for OnionProxyConfig

fn eq(&self, other: &OnionProxyConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for OnionProxyConfig