Struct hickory_resolver::Resolver

source ·
pub struct Resolver { /* private fields */ }
Available on crate feature tokio-runtime only.
Expand description

The Resolver is used for performing DNS queries.

For forward (A) lookups, hostname -> IP address, see: Resolver::lookup_ip

Special note about resource consumption. The Resolver and all Hickory DNS software is built around the Tokio async-io library. This synchronous Resolver is intended to be a simpler wrapper for of the AsyncResolver. To allow the Resolver to be Send + Sync, the construction of the AsyncResolver is lazy, this means some of the features of the AsyncResolver, like performance based resolution via the most efficient NameServer will be lost (the lookup cache is shared across invocations of the Resolver). If these other features of the Hickory DNS Resolver are desired, please use the tokio based AsyncResolver.

Note: Threaded/Sync usage: In multithreaded scenarios, the internal Tokio Runtime will block on an internal Mutex for the tokio Runtime in use. For higher performance, it’s recommended to use the AsyncResolver.

Implementations§

source§

impl Resolver

source

pub fn new(config: ResolverConfig, options: ResolverOpts) -> Result<Self>

Constructs a new Resolver with the specified configuration.

§Arguments
  • config - configuration for the resolver
  • options - resolver options for performing lookups
§Returns

A new Resolver or an error if there was an error with the configuration.

source

pub fn default() -> Result<Self>

Constructs a new Resolver with default config and default options.

See ResolverConfig::default and ResolverOpts::default for more information.

§Returns

A new Resolver or an error if there was an error with the configuration.

source

pub fn from_system_conf() -> Result<Self>

Available on crate feature system-config and (Unix or Windows) only.

Constructs a new Resolver with the system configuration.

This will use /etc/resolv.conf on Unix OSes and the registry on Windows.

source

pub fn clear_cache(&self)

Flushes/Removes all entries from the cache

source

pub fn config(&self) -> &ResolverConfig

Read the config for this resolver.

source

pub fn options(&self) -> &ResolverOpts

Read the options for this resolver.

source

pub fn lookup<N: IntoName>( &self, name: N, record_type: RecordType, ) -> ResolveResult<Lookup>

Generic lookup for any RecordType

WARNING This interface may change in the future, please use Self::lookup_ip or another variant for more stable interfaces.

§Arguments
  • name - name of the record to lookup, if name is not a valid domain name, an error will be returned
  • record_type - type of record to lookup
source

pub fn lookup_ip<N: IntoName + TryParseIp>( &self, host: N, ) -> ResolveResult<LookupIp>

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.
source

pub fn reverse_lookup(&self, query: IpAddr) -> ResolveResult<ReverseLookup>

Performs a lookup for the associated type.

§Arguments
  • query - a type which can be converted to Name via From.
source

pub fn ipv4_lookup<N: IntoName>(&self, query: N) -> ResolveResult<Ipv4Lookup>

Performs a lookup for the associated type.

hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups

§Arguments
  • query - a &str which parses to a domain name, failure to parse will return an error
source

pub fn ipv6_lookup<N: IntoName>(&self, query: N) -> ResolveResult<Ipv6Lookup>

Performs a lookup for the associated type.

hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups

§Arguments
  • query - a &str which parses to a domain name, failure to parse will return an error
source

pub fn mx_lookup<N: IntoName>(&self, query: N) -> ResolveResult<MxLookup>

Performs a lookup for the associated type.

hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups

§Arguments
  • query - a &str which parses to a domain name, failure to parse will return an error
source

pub fn ns_lookup<N: IntoName>(&self, query: N) -> ResolveResult<NsLookup>

Performs a lookup for the associated type.

hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups

§Arguments
  • query - a &str which parses to a domain name, failure to parse will return an error
source

pub fn soa_lookup<N: IntoName>(&self, query: N) -> ResolveResult<SoaLookup>

Performs a lookup for the associated type.

hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups

§Arguments
  • query - a &str which parses to a domain name, failure to parse will return an error
source

pub fn srv_lookup<N: IntoName>(&self, query: N) -> ResolveResult<SrvLookup>

Performs a lookup for the associated type.

hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups

§Arguments
  • query - a &str which parses to a domain name, failure to parse will return an error
source

pub fn tlsa_lookup<N: IntoName>(&self, query: N) -> ResolveResult<TlsaLookup>

Performs a lookup for the associated type.

hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups

§Arguments
  • query - a &str which parses to a domain name, failure to parse will return an error
source

pub fn txt_lookup<N: IntoName>(&self, query: N) -> ResolveResult<TxtLookup>

Performs a lookup for the associated type.

hint queries that end with a ‘.’ are fully qualified names and are cheaper lookups

§Arguments
  • query - a &str which parses to a domain name, failure to parse will return an error

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

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

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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