Struct ClientBuilder

pub struct ClientBuilder { /* private fields */ }

Build a Client.

Implementations

impl ClientBuilder

pub fn new( url: impl Into<RelayUrl>, secret_key: SecretKey, dns_resolver: DnsResolver, ) -> Self

Create a new ClientBuilder

pub fn protocol(self, protocol: Protocol) -> Self

Sets whether to connect to the relay via websockets or not. Set to use non-websocket, normal relaying by default.

pub fn address_family_selector<S>(self, selector: S) -> Self

where S: Fn() -> bool + Send + Sync + 'static,

Returns if we should prefer ipv6 it replaces the relayhttp.AddressFamilySelector we pass It provides the hint as to whether in an IPv4-vs-IPv6 race that IPv4 should be held back a bit to give IPv6 a better-than-50/50 chance of winning. We only return true when we believe IPv6 will work anyway, so we don’t artificially delay the connection speed.

pub fn is_prober(self, is: bool) -> Self

Indicates this client is a prober

pub fn insecure_skip_cert_verify(self, skip: bool) -> Self

Available on crate feature test-utils only.

Skip the verification of the relay server’s SSL certificates.

May only be used in tests.

pub fn proxy_url(self, url: Url) -> Self

Set an explicit proxy url to proxy all HTTP(S) traffic through.

pub fn key_cache_capacity(self, capacity: usize) -> Self

Set the capacity of the cache for public keys.

pub async fn connect(&self) -> Result<Client>

Establishes a new connection to the relay server.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.