Struct trust_dns_client::client::AsyncClient

source · [−]

pub struct AsyncClient { /* private fields */ }

Expand description

A DNS Client implemented over futures-rs.

This Client is generic and capable of wrapping UDP, TCP, and other underlying DNS protocol implementations.

Implementations

impl AsyncClient

pub async fn new<F, S>(
    stream: F,
    stream_handle: BufDnsStreamHandle,
    signer: Option<Arc<Signer>>
) -> Result<(AsyncClient, DnsExchangeBackground<DnsMultiplexer<S, Signer>, TokioTime>), ProtoError> where
    F: Future<Output = Result<S, ProtoError>> + Send + Unpin + 'static,
    S: DnsClientStream + 'static + Unpin,

Spawns a new AsyncClient Stream. This uses a default timeout of 5 seconds for all requests.

Arguments

stream - A stream of bytes that can be used to send/receive DNS messages (see TcpClientStream or UdpClientStream)
stream_handle - The handle for the stream on which bytes can be sent/received.
signer - An optional signer for requests, needed for Updates with Sig0, otherwise not needed

pub async fn with_timeout<F, S>(
    stream: F,
    stream_handle: BufDnsStreamHandle,
    timeout_duration: Duration,
    signer: Option<Arc<Signer>>
) -> Result<(AsyncClient, DnsExchangeBackground<DnsMultiplexer<S, Signer>, TokioTime>), ProtoError> where
    F: Future<Output = Result<S, ProtoError>> + 'static + Send + Unpin,
    S: DnsClientStream + 'static + Unpin,

Spawns a new AsyncClient Stream.

Arguments

stream - A stream of bytes that can be used to send/receive DNS messages (see TcpClientStream or UdpClientStream)
timeout_duration - All requests may fail due to lack of response, this is the time to wait for a response before canceling the request.
stream_handle - The handle for the stream on which bytes can be sent/received.
signer - An optional signer for requests, needed for Updates with Sig0, otherwise not needed

pub async fn connect<F, S>(
    connect_future: F
) -> Result<(AsyncClient, DnsExchangeBackground<S, TokioTime>), ProtoError> where
    S: DnsRequestSender,
    F: Future<Output = Result<S, ProtoError>> + 'static + Send + Unpin,

Returns a future, which itself wraps a future which is awaiting connection.

The connect_future should be lazy.

Returns

This returns a tuple of Self a handle to send dns messages and an optional background. The background task must be run on an executor before handle is used, if it is Some. If it is None, then another thread has already run the background.

pub fn enable_edns(&mut self)

(Re-)enable usage of EDNS for outgoing messages

pub fn disable_edns(&mut self)

Disable usage of EDNS for outgoing messages

Trait Implementations

impl Clone for AsyncClient

fn clone(&self) -> AsyncClient

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl DnsHandle for AsyncClient

type Response = DnsExchangeSend

The associated response from the response stream, this should resolve to the Response messages

type Error = ProtoError

Error of the response, generally this will be ProtoError

fn send<R: Into<DnsRequest> + Unpin + Send + 'static>(
&mut self,
request: R
) -> Self::Response

Send a message via the channel in the client Read more

fn is_using_edns(&self) -> bool

Allow for disabling EDNS

fn is_verifying_dnssec(&self) -> bool

Only returns true if and only if this DNS handle is validating DNSSec. Read more

fn lookup(&mut self, query: Query, options: DnsRequestOptions) -> Self::Response

A classic DNS query Read more

Auto Trait Implementations

impl !RefUnwindSafe for AsyncClient

impl Send for AsyncClient

impl Sync for AsyncClient

impl Unpin for AsyncClient

impl !UnwindSafe for AsyncClient

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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.

const: unstable · source

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

Performs the conversion.

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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