Struct libp2p::dns::DnsConfig

pub struct DnsConfig<T> { /* fields omitted */ }

Represents the configuration for a DNS transport capability of libp2p.

This struct implements the Transport trait and holds an underlying transport. Any call to dial with a multiaddr that contains /dns/, /dns4/, or /dns6/ will be first be resolved, then passed to the underlying transport.

Listening is unaffected.

Implementations

impl<T> DnsConfig<T>

pub fn new(inner: T) -> Result<DnsConfig<T>, Error>

Creates a new configuration object for DNS.

pub fn with_resolve_threads(
    inner: T,
    num_threads: usize
) -> Result<DnsConfig<T>, Error>

Same as new, but allows specifying a number of threads for the resolving.

Trait Implementations

impl<T> Clone for DnsConfig<T> where
    T: Clone, 

pub fn clone(&self) -> DnsConfig<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for DnsConfig<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> Transport for DnsConfig<T> where
    T: Transport + Send + 'static,
    <T as Transport>::Error: Send,
    <T as Transport>::Dial: Send, 

type Output = <T as Transport>::Output

The result of a connection setup process, including protocol upgrades.

type Error = DnsErr<<T as Transport>::Error>

An error that occurred during connection setup.

type Listener = MapErr<MapOk<<T as Transport>::Listener, fn(ListenerEvent<<T as Transport>::ListenerUpgrade, <T as Transport>::Error>) -> ListenerEvent<<DnsConfig<T> as Transport>::ListenerUpgrade, <DnsConfig<T> as Transport>::Error>>, fn(<T as Transport>::Error) -> <DnsConfig<T> as Transport>::Error>

A stream of Outputs for inbound connections.

type ListenerUpgrade = MapErr<<T as Transport>::ListenerUpgrade, fn(<T as Transport>::Error) -> <DnsConfig<T> as Transport>::Error>

A pending Output for an inbound connection, obtained from the Listener stream.

type Dial = Either<MapErr<<T as Transport>::Dial, fn(<T as Transport>::Error) -> <DnsConfig<T> as Transport>::Error>, Pin<Box<dyn Future<Output = Result<<DnsConfig<T> as Transport>::Output, <DnsConfig<T> as Transport>::Error>> + 'static + Send, Global>>>

A pending Output for an outbound connection, obtained from dialing.

pub fn listen_on(
    self,
    addr: Multiaddr
) -> Result<<DnsConfig<T> as Transport>::Listener, TransportError<<DnsConfig<T> as Transport>::Error>>

Listens on the given Multiaddr, producing a stream of pending, inbound connections and addresses this transport is listening on (cf. ListenerEvent).

pub fn dial(
    self,
    addr: Multiaddr
) -> Result<<DnsConfig<T> as Transport>::Dial, TransportError<<DnsConfig<T> as Transport>::Error>>

Dials the given Multiaddr, returning a future for a pending outbound connection.

pub fn boxed(self) -> Boxed<Self::Output, Self::Error> where
    Self: Clone + Send + Sync + 'static,
    Self::Dial: Send,
    Self::Dial: 'static,
    Self::Listener: Send,
    Self::Listener: 'static,
    Self::ListenerUpgrade: Send,
    Self::ListenerUpgrade: 'static, 

Turns the transport into an abstract boxed (i.e. heap-allocated) transport.

pub fn map<F, O>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Output, ConnectedPoint) -> O + Clone, 

Applies a function on the connections created by the transport.

pub fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E + Clone, 

Applies a function on the errors generated by the futures of the transport.

pub fn or_transport<U>(self, other: U) -> OrTransport<Self, U> where
    U: Transport,
    <U as Transport>::Error: 'static, 

Adds a fallback transport that is used when encountering errors while establishing inbound or outbound connections.

pub fn and_then<C, F, O>(self, f: C) -> AndThen<Self, C> where
    C: FnOnce(Self::Output, ConnectedPoint) -> F + Clone,
    F: TryFuture<Ok = O>,
    <F as TryFuture>::Error: Error,
    <F as TryFuture>::Error: 'static, 

Applies a function producing an asynchronous result to every connection created by this transport.

pub fn timeout(self, timeout: Duration) -> TransportTimeout<Self>

Adds a timeout to the connection setup (including upgrades) for all inbound and outbound connections established through the transport.

pub fn outbound_timeout(self, timeout: Duration) -> TransportTimeout<Self>

Adds a timeout to the connection setup (including upgrades) for all outbound connections established through the transport.

pub fn inbound_timeout(self, timeout: Duration) -> TransportTimeout<Self>

Adds a timeout to the connection setup (including upgrades) for all inbound connections established through the transport.

pub fn upgrade(self, version: Version) -> Builder<Self> where
    Self::Error: 'static, 

Begins a series of protocol upgrades via an upgrade::Builder.