Struct Client

Source

pub struct Client<P> { /* 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§

Source §

impl<P: RuntimeProvider> Client

Source

pub fn new<S: DnsClientStream>( stream: S, stream_handle: BufDnsStreamHandle, ) -> (Self, DnsExchangeBackground<DnsMultiplexer<S>, P::Timer>)

Spawns a new Client 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.

Source

pub fn with_timeout<S: DnsClientStream>( stream: S, stream_handle: BufDnsStreamHandle, timeout_duration: Duration, ) -> (Self, DnsExchangeBackground<DnsMultiplexer<S>, P::Timer>)

Spawns a new Client Stream.

§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.
timeout_duration - All requests may fail due to lack of response, this is the time to wait for a response before canceling the request.

Source

pub fn from_sender<S: DnsRequestSender>( sender: S, ) -> (Self, DnsExchangeBackground<S, P::Timer>)

Creates a Client from an existing DnsRequestSender

Source

pub fn enable_edns(&mut self)

(Re-)enable usage of EDNS for outgoing messages

Source

pub fn disable_edns(&mut self)

Disable usage of EDNS for outgoing messages

Trait Implementations§

Source §

impl<P: Clone> Clone for Client

Source §

fn clone(&self) -> Client

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<P: RuntimeProvider> DnsHandle for Client

Source §

type Response = DnsExchangeSend

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

Source §

type Runtime = P

The asynchronous runtime in use.

Source §

fn send(&self, request: DnsRequest) -> Self::Response

Send a message via the channel in the client Read more

Source §

fn is_using_edns(&self) -> bool

Allow for disabling EDNS

Source §

fn is_verifying_dnssec(&self) -> bool

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

Source §

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

A classic DNS query Read more

Auto Trait Implementations§

§

impl !UnwindSafe for Client

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> ClientHandle for T
where T: DnsHandle,

Source §

fn query( &mut self, name: Name, query_class: DNSClass, query_type: RecordType, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ

A classic DNS query Read more

Source §

fn notify<R>( &mut self, name: Name, query_class: DNSClass, query_type: RecordType, rrset: Option<R>, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ
where R: Into<RecordSet>,

Sends a NOTIFY message to the remote system Read more

Source §

fn create<R>( &mut self, rrset: R, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ
where R: Into<RecordSet>,

Sends a record to create on the server, this will fail if the record exists (atomicity depends on the server) Read more

Source §

fn append<R>( &mut self, rrset: R, zone_origin: Name, must_exist: bool, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ
where R: Into<RecordSet>,

Appends a record to an existing rrset, optionally require the rrset to exist (atomicity depends on the server) Read more

Source §

fn compare_and_swap<C, N>( &mut self, current: C, new: N, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ
where C: Into<RecordSet>, N: Into<RecordSet>,

Compares and if it matches, swaps it for the new value (atomicity depends on the server) Read more

Source §

fn delete_by_rdata<R>( &mut self, rrset: R, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ
where R: Into<RecordSet>,

Deletes a record (by rdata) from an rrset, optionally require the rrset to exist. Read more

Source §

fn delete_rrset( &mut self, record: Record, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ

Deletes an entire rrset, optionally require the rrset to exist. Read more

Source §

fn delete_all( &mut self, name_of_records: Name, zone_origin: Name, dns_class: DNSClass, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ

Deletes all records at the specified name Read more

Source §

fn zone_transfer( &mut self, zone_origin: Name, last_soa: Option<SOA>, ) -> ClientStreamXfr<<Self as DnsHandle>::Response>

Download all records from a zone, or all records modified since given SOA was observed. The request will either be a AXFR Query (ask for full zone transfer) if a SOA was not provided, or a IXFR Query (incremental zone transfer) if a SOA was provided. Read more

Source §

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

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. 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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

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

Source §

type Owned = T

The resulting type after obtaining ownership.

Source §

fn to_owned(&self) -> T

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

Source §

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

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

Source §

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

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

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

Struct Client Copy item path

Implementations§

impl<P: RuntimeProvider> Client<P>

pub fn new<S: DnsClientStream>( stream: S, stream_handle: BufDnsStreamHandle, ) -> (Self, DnsExchangeBackground<DnsMultiplexer<S>, P::Timer>)

§Arguments

pub fn with_timeout<S: DnsClientStream>( stream: S, stream_handle: BufDnsStreamHandle, timeout_duration: Duration, ) -> (Self, DnsExchangeBackground<DnsMultiplexer<S>, P::Timer>)

§Arguments

pub fn from_sender<S: DnsRequestSender>( sender: S, ) -> (Self, DnsExchangeBackground<S, P::Timer>)

pub fn enable_edns(&mut self)

pub fn disable_edns(&mut self)

Trait Implementations§

impl<P: Clone> Clone for Client<P>

fn clone(&self) -> Client<P>

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

impl<P: RuntimeProvider> DnsHandle for Client<P>

type Response = DnsExchangeSend<P>

type Runtime = P

fn send(&self, request: DnsRequest) -> Self::Response

fn is_using_edns(&self) -> bool

fn is_verifying_dnssec(&self) -> bool

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

Auto Trait Implementations§

impl<P> Freeze for Client<P>

impl<P> !RefUnwindSafe for Client<P>

impl<P> Send for Client<P>where P: Send,

impl<P> Sync for Client<P>where P: Sync,

impl<P> Unpin for Client<P>where P: Unpin,

impl<P> UnsafeUnpin for Client<P>

impl<P> !UnwindSafe for Client<P>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> ClientHandle for Twhere T: DnsHandle,

fn query( &mut self, name: Name, query_class: DNSClass, query_type: RecordType, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ

fn notify<R>( &mut self, name: Name, query_class: DNSClass, query_type: RecordType, rrset: Option<R>, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘwhere R: Into<RecordSet>,

fn create<R>( &mut self, rrset: R, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘwhere R: Into<RecordSet>,

fn append<R>( &mut self, rrset: R, zone_origin: Name, must_exist: bool, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘwhere R: Into<RecordSet>,

fn compare_and_swap<C, N>( &mut self, current: C, new: N, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘwhere C: Into<RecordSet>, N: Into<RecordSet>,

fn delete_by_rdata<R>( &mut self, rrset: R, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘwhere R: Into<RecordSet>,

fn delete_rrset( &mut self, record: Record, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ

fn delete_all( &mut self, name_of_records: Name, zone_origin: Name, dns_class: DNSClass, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ

fn zone_transfer( &mut self, zone_origin: Name, last_soa: Option<SOA>, ) -> ClientStreamXfr<<Self as DnsHandle>::Response>

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct Client

impl<P> Send for Client<P>
where P: Send,

impl<P> Sync for Client<P>
where P: Sync,

impl<P> Unpin for Client<P>
where P: Unpin,

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

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

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

impl<T> ClientHandle for T
where T: DnsHandle,

fn notify<R>( &mut self, name: Name, query_class: DNSClass, query_type: RecordType, rrset: Option<R>, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ
where R: Into<RecordSet>,

fn create<R>( &mut self, rrset: R, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ
where R: Into<RecordSet>,

fn append<R>( &mut self, rrset: R, zone_origin: Name, must_exist: bool, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ
where R: Into<RecordSet>,

fn compare_and_swap<C, N>( &mut self, current: C, new: N, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ
where C: Into<RecordSet>, N: Into<RecordSet>,

fn delete_by_rdata<R>( &mut self, rrset: R, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response> ⓘ
where R: Into<RecordSet>,

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

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,