Struct Client

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

Source

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

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.
  • signer - An optional signer for requests, needed for Updates with Sig0, otherwise not needed
Source

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

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.
  • signer - An optional signer for requests, needed for Updates with Sig0, otherwise not needed
Source

pub async fn connect<F, S>( connect_future: F, ) -> Result<(Self, 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.

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 Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl DnsHandle for Client

Source§

type Response = DnsExchangeSend

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

fn send<R: Into<DnsRequest> + Unpin + Send + 'static>( &self, request: R, ) -> 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 Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

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<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> 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<U> 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<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T