Update libp2p-dns doc to include /dns/ support (#1634)

Now that /dns/ is supported, it should be mentioned in
the documentation as well.
This commit is contained in:
Mikhail Zabaluev 2020-06-29 16:05:11 +03:00 committed by GitHub
parent 7fd69ecf3f
commit b61c3f9d04
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -29,8 +29,8 @@
//! implementation of the `Transport` trait. //! implementation of the `Transport` trait.
//! //!
//! Whenever we want to dial an address through the `DnsConfig` and that address contains a //! Whenever we want to dial an address through the `DnsConfig` and that address contains a
//! `/dns4/` or `/dns6/` component, a DNS resolve will be performed and the component will be //! `/dns/`, `/dns4/`, or `/dns6/` component, a DNS resolve will be performed and the component
//! replaced with respectively an `/ip4/` or an `/ip6/` component. //! will be replaced with `/ip4/` and/or `/ip6/` components.
//! //!
use futures::{prelude::*, channel::oneshot, future::BoxFuture}; use futures::{prelude::*, channel::oneshot, future::BoxFuture};
@ -45,8 +45,8 @@ use std::{error, fmt, io, net::ToSocketAddrs};
/// Represents the configuration for a DNS transport capability of libp2p. /// Represents the configuration for a DNS transport capability of libp2p.
/// ///
/// This struct implements the `Transport` trait and holds an underlying transport. Any call to /// This struct implements the `Transport` trait and holds an underlying transport. Any call to
/// `dial` with a multiaddr that contains `/dns4/` or `/dns6/` will be first be resolved, then /// `dial` with a multiaddr that contains `/dns/`, `/dns4/`, or `/dns6/` will be first be resolved,
/// passed to the underlying transport. /// then passed to the underlying transport.
/// ///
/// Listening is unaffected. /// Listening is unaffected.
#[derive(Clone)] #[derive(Clone)]