Struct trust_dns_resolver::AsyncResolver
source · pub struct AsyncResolver { /* private fields */ }
Expand description
A handle for resolving DNS records.
Creating a AsyncResolver
returns a new handle and a future that should
be spawned on an executor to drive the background work. The lookup methods
on AsyncResolver
request lookups from the background task.
The futures returned by a AsyncResolver
and the corresponding background
task need not be spawned on the same executor, or be in the same thread.
Additionally, one background task may have any number of handles; calling
clone()
on a handle will create a new handle linked to the same
background task.
NOTE If lookup futures returned by a AsyncResolver
and the background
future are spawned on two separate CurrentThread
executors, one thread
cannot run both executors simultaneously, so the run
or block_on
functions will cause the thread to deadlock. If both the background work
and the lookup futures are intended to be run on the same thread, they
should be spawned on the same executor.
The background task manages the name server pool and other state used
to drive lookups. When this future is spawned on an executor, it will
first construct and configure the necessary client state, before checking
for any incoming lookup requests, handling them, and and yielding. It will
continue to do so as long as there are still any AsyncResolver
handle
linked to it. When all of its AsyncResolver
s have been dropped, the
background future will finish.
Implementations
sourceimpl AsyncResolver
impl AsyncResolver
sourcepub fn new(
config: ResolverConfig,
options: ResolverOpts
) -> (Self, impl Future<Item = (), Error = ()>)
pub fn new(
config: ResolverConfig,
options: ResolverOpts
) -> (Self, impl Future<Item = (), Error = ()>)
Construct a new AsyncResolver
with the provided configuration.
Arguments
config
- configuration, name_servers, etc. for the Resolveroptions
- basic lookup options for the resolver
Returns
A tuple containing the new AsyncResolver
and a future that drives the
background task that runs resolutions for the AsyncResolver
. See the
documentation for AsyncResolver
for more information on how to use
the background future.
sourcepub fn from_system_conf(
) -> ResolveResult<(Self, impl Future<Item = (), Error = ()>)>
pub fn from_system_conf(
) -> ResolveResult<(Self, impl Future<Item = (), Error = ()>)>
Constructs a new Resolver with the system configuration.
This will use /etc/resolv.conf
on Unix OSes and the registry on Windows.
sourcepub fn lookup<N: IntoName>(
&self,
name: N,
record_type: RecordType
) -> BackgroundLookup
pub fn lookup<N: IntoName>(
&self,
name: N,
record_type: RecordType
) -> BackgroundLookup
Generic lookup for any RecordType
WARNING this interface may change in the future, see if one of the specializations would be better.
Arguments
name
- name of the record to lookup, if name is not a valid domain name, an error will be returnedrecord_type
- type of record to lookup, all RecordData responses will be filtered to this type
Returns
sourcepub fn lookup_ip<N: IntoName + TryParseIp>(&self, host: N) -> BackgroundLookupIp
pub fn lookup_ip<N: IntoName + TryParseIp>(&self, host: N) -> BackgroundLookupIp
Performs a dual-stack DNS lookup for the IP for the given hostname.
See the configuration and options parameters for controlling the way in which A(Ipv4) and AAAA(Ipv6) lookups will be performed. For the least expensive query a fully-qualified-domain-name, FQDN, which ends in a final .
, e.g. www.example.com.
, will only issue one query. Anything else will always incur the cost of querying the ResolverConfig::domain
and ResolverConfig::search
.
Arguments
host
- string hostname, if this is an invalid hostname, an error will be returned.
sourcepub fn lookup_service(
&self,
service: &str,
protocol: &str,
name: &str
) -> BackgroundLookup<SrvLookupFuture>
👎Deprecated: use lookup_srv instead, this interface is none ideal
pub fn lookup_service(
&self,
service: &str,
protocol: &str,
name: &str
) -> BackgroundLookup<SrvLookupFuture>
Performs a DNS lookup for an SRV record for the specified service type and protocol at the given name.
This is a convenience method over lookup_srv
, it combines the service, protocol and name into a single name: _service._protocol.name
.
Arguments
service
- service to lookup, e.g. ldap or httpprotocol
- wire protocol, e.g. udp or tcpname
- zone or other name at which the service is located.
sourcepub fn lookup_srv<N: IntoName>(
&self,
name: N
) -> BackgroundLookup<SrvLookupFuture>
pub fn lookup_srv<N: IntoName>(
&self,
name: N
) -> BackgroundLookup<SrvLookupFuture>
Lookup an SRV record.
sourcepub fn reverse_lookup(
&self,
query: IpAddr
) -> BackgroundLookup<ReverseLookupFuture>
pub fn reverse_lookup(
&self,
query: IpAddr
) -> BackgroundLookup<ReverseLookupFuture>
Performs a lookup for the associated type.
Arguments
query
- a type which can be converted toName
viaFrom
.
sourcepub fn ipv4_lookup<N: IntoName>(
&self,
query: N
) -> BackgroundLookup<Ipv4LookupFuture>
pub fn ipv4_lookup<N: IntoName>(
&self,
query: N
) -> BackgroundLookup<Ipv4LookupFuture>
Performs a lookup for the associated type.
hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups
Arguments
query
- a string which parses to a domain name, failure to parse will return an error
sourcepub fn ipv6_lookup<N: IntoName>(
&self,
query: N
) -> BackgroundLookup<Ipv6LookupFuture>
pub fn ipv6_lookup<N: IntoName>(
&self,
query: N
) -> BackgroundLookup<Ipv6LookupFuture>
Performs a lookup for the associated type.
hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups
Arguments
query
- a string which parses to a domain name, failure to parse will return an error
sourcepub fn mx_lookup<N: IntoName>(
&self,
query: N
) -> BackgroundLookup<MxLookupFuture>
pub fn mx_lookup<N: IntoName>(
&self,
query: N
) -> BackgroundLookup<MxLookupFuture>
Performs a lookup for the associated type.
hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups
Arguments
query
- a string which parses to a domain name, failure to parse will return an error
sourcepub fn srv_lookup<N: IntoName>(
&self,
query: N
) -> BackgroundLookup<SrvLookupFuture>
pub fn srv_lookup<N: IntoName>(
&self,
query: N
) -> BackgroundLookup<SrvLookupFuture>
Performs a lookup for the associated type.
hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups
Arguments
query
- a string which parses to a domain name, failure to parse will return an error
sourcepub fn txt_lookup<N: IntoName>(
&self,
query: N
) -> BackgroundLookup<TxtLookupFuture>
pub fn txt_lookup<N: IntoName>(
&self,
query: N
) -> BackgroundLookup<TxtLookupFuture>
Performs a lookup for the associated type.
hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups
Arguments
query
- a string which parses to a domain name, failure to parse will return an error
Trait Implementations
sourceimpl Clone for AsyncResolver
impl Clone for AsyncResolver
sourcefn clone(&self) -> AsyncResolver
fn clone(&self) -> AsyncResolver
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more