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
impl Client
Sourcepub 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,
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 thestreamon which bytes can be sent/received.signer- An optional signer for requests, needed for Updates with Sig0, otherwise not needed
Sourcepub 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,
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 thestreamon 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
Sourcepub async fn connect<F, S>(
connect_future: F,
) -> Result<(Self, DnsExchangeBackground<S, TokioTime>), ProtoError>
pub async fn connect<F, S>( connect_future: F, ) -> Result<(Self, DnsExchangeBackground<S, TokioTime>), ProtoError>
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.
Sourcepub fn enable_edns(&mut self)
pub fn enable_edns(&mut self)
(Re-)enable usage of EDNS for outgoing messages
Sourcepub fn disable_edns(&mut self)
pub fn disable_edns(&mut self)
Disable usage of EDNS for outgoing messages
Trait Implementations§
Source§impl DnsHandle for Client
impl DnsHandle for Client
Source§type Response = DnsExchangeSend
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
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
fn is_using_edns(&self) -> bool
Allow for disabling EDNS
Source§fn is_verifying_dnssec(&self) -> bool
fn is_verifying_dnssec(&self) -> bool
Only returns true if and only if this DNS handle is validating DNSSEC. 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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> ClientHandle for Twhere
T: DnsHandle,
impl<T> ClientHandle for Twhere
T: DnsHandle,
Source§fn query(
&mut self,
name: Name,
query_class: DNSClass,
query_type: RecordType,
) -> ClientResponse<<Self as DnsHandle>::Response>
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>
fn notify<R>( &mut self, name: Name, query_class: DNSClass, query_type: RecordType, rrset: Option<R>, ) -> ClientResponse<<Self as DnsHandle>::Response>
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>
fn create<R>( &mut self, rrset: R, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response>
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>
fn append<R>( &mut self, rrset: R, zone_origin: Name, must_exist: bool, ) -> ClientResponse<<Self as DnsHandle>::Response>
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>
fn compare_and_swap<C, N>( &mut self, current: C, new: N, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response>
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>
fn delete_by_rdata<R>( &mut self, rrset: R, zone_origin: Name, ) -> ClientResponse<<Self as DnsHandle>::Response>
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>
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>
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>
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