iroh_net::relay

Struct HttpClientBuilder

pub struct HttpClientBuilder { /* private fields */ }

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Expand description

Build a Client.

Implementations§

impl ClientBuilder

pub fn new(url: impl Into<RelayUrl>) -> Self

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Create a new ClientBuilder

pub fn server_url(self, url: impl Into<RelayUrl>) -> Self

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Sets the server url

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

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

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() -> BoxFuture<bool> + Send + Sync + 'static,

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

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 can_ack_pings(self, can: bool) -> Self

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Enable this Client to acknowledge pings.

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

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Indicate this client is the preferred way to communicate to the peer with this client’s PublicKey

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

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Indicates this client is a prober

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

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Available on test or 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

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

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

pub fn build( self, key: SecretKey, dns_resolver: DnsResolver, ) -> (Client, ClientReceiver)

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Build the Client

pub fn server_public_key(self, server_public_key: PublicKey) -> Self

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

The expected PublicKey of the relay server we are connecting to.

Trait Implementations§

impl Debug for ClientBuilder

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for ClientBuilder

impl !RefUnwindSafe for ClientBuilder

impl Send for ClientBuilder

impl Sync for ClientBuilder

impl Unpin for ClientBuilder

impl !UnwindSafe for ClientBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T