Struct QDns

Source

pub struct QDns<LOC: Sync + Send = SocketBase, TAP: SocketTaps<LOC> = SocketBase, MC: MutexedCaches = IoInterf> { /* private fields */ }

Expand description

A main instance which contains all common logic. All requests for name/host resolutions should be perfomed using this structure.

let dns_req = 
    QDns::<SocketBase, SocketBase, IoInterf>::make_empty(Some(cust.clone()), QuerySetup::default(), cache.clone())
        .await
        .unwrap();

 dns_req.add_request(QType::SOA, "protonmail.com");

This struct is for the async with the user provided interface to the async executor items like sockets, files, etc…

feature = “built_in_async” which s enabled by the feature use_async_tokio.

§Generics

LOC - this generic do nothing and needed to overcome the problem of the foreign stucts and traits implemented outside of the crate. “only traits defined in the current crate can be implemented for types defined outside of the crate”. Usually is set to the same type as TAP. By default, it is preset to SocketBase.
TAP - a generic which should implement SocketTaps which will be used by the crate. By default, it is pre set to SocketBase.
MC - a generic which should implement MutexedCaches which provides the file and mutex funtionality. By default, it is pre set to TokioInterf.

Implementations§

Source §

impl QDns<SocketBase>

Source

pub async fn builtin_make_empty( resolvers: Option<Arc<ResolveConfig>>, opts: QuerySetup, cache: Arc<CachesController<TokioInterf>>, ) -> CDnsResult<QDns<SocketBase, SocketBase, TokioInterf>>

Initializes new empty storage for requests.

In some cases it is good idea to combine different requests, because by default all requests are performed in parallel. But in some cases it is bad idea.

§Arguments

resolvers - an Arc ResolveConfig which contains configuration i.e nameservers
planned_reqs_len - how many requests are planned
opts - QuerySetup additional options or overrides. Use default() for default values.
cache - a Arc to CachesController which should be prepared before calling this function.

§Returns

A CDnsResult is returned (Result alias) where:

Result::Ok is returned with the new instance.
Result::Err is returned with error description. The error may happen during attempt to read resolv config or obtain a cached verion.

Source

pub fn buildin_add_request( &mut self, qtype: QType, req_name: impl Into<QDnsName>, )

Adds a new request to current instance.

§Arguemnts

qtype - a QType type of the request
req_name - a Into QDnsName which is target. i.e ‘localhost’ or ‘domain.tld’

Source

pub async fn buildin_make_a_aaaa_request( resolvers_opt: Option<Arc<ResolveConfig>>, req_name: impl Into<QDnsName>, opts: QuerySetup, cache: Arc<CachesController<TokioInterf>>, ) -> CDnsResult<Self>

This is helper which makes for you an A, AAAA query. The order of A and AAAA is defined in the ResolveConfig.

Use this function directly. Do not use QDns::make_empty

§Arguments

resolvers - an Option value Arc ResolveConfig which can be used to override the system’s resolv.conf
req_name - a Into QDnsName which is target i.e ‘localhost’ or ‘domain.tld’
opts - QuerySetup additional options or overrides. Use default() for default values.
cache - a Arc to CachesController which should be prepared before calling this function.

§Returns

A CDnsResult is returned;

Result::Ok - with Self as inner type
Result::Err is returned with error description. The error may happen during attempt to read resolv config or obtain a cached verion.

Source §

impl<LOC: Sync + Send, TAP: SocketTaps<LOC>, MC: MutexedCaches> QDns<LOC, TAP, MC>

Source

pub async fn make_empty( resolvers: Option<Arc<ResolveConfig>>, opts: QuerySetup, cache: Arc<CachesController<MC>>, ) -> CDnsResult<QDns<LOC, TAP, MC>>

Initializes new empty storage for requests.

§Arguments

resolvers - an Arc ResolveConfig which contains configuration i.e nameservers
planned_reqs_len - how many requests are planned
opts - QuerySetup additional options or overrides. Use default() for default values.
cache - a Arc to CachesController which should be prepared before calling this function.

§Returns

A CDnsResult is returned (Result alias) where:

Result::Ok is returned with the new instance.
Result::Err is returned with error description. The error may happen during attempt to read resolv config or obtain a cached verion.

Source

pub fn add_request(&mut self, qtype: QType, req_name: impl Into<QDnsName>)

Adds a new request to current instance.

§Arguemnts

qtype - a QType type of the request
req_name - a Into QDnsName which is target. i.e ‘localhost’ or ‘domain.tld’

Source

pub async fn make_a_aaaa_request( resolvers_opt: Option<Arc<ResolveConfig>>, req_name: impl Into<QDnsName>, opts: QuerySetup, cache: Arc<CachesController<MC>>, ) -> CDnsResult<Self>

This is helper which makes for you an A, AAAA query. The order of A and AAAA is defined in the ResolveConfig.

Use this function directly. Do not use QDns::make_empty

§Arguments

resolvers - an Option value Arc ResolveConfig which can be used to override the system’s resolv.conf
req_name - a Into QDnsName which is target i.e ‘localhost’ or ‘domain.tld’
opts - QuerySetup additional options or overrides. Use default() for default values.
cache - a Arc to CachesController which should be prepared before calling this function.

§Returns

A CDnsResult is returned;

Result::Ok - with Self as inner type
Result::Err is returned with error description. The error may happen during attempt to read resolv config or obtain a cached verion.

Source