Struct trust_dns::client::ClientFuture

pub struct ClientFuture<SenderFuture, Sender, Response>where
    SenderFuture: Future<Item = Sender, Error = ProtoError> + 'static + Send,
    Sender: DnsRequestSender<DnsResponseFuture = Response> + 'static,
    Response: Future<Item = DnsResponse, Error = ProtoError> + 'static + Send,{ /* private fields */ }

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<F, S> ClientFuture<DnsMultiplexerConnect<F, S, Signer>, DnsMultiplexer<S, Signer, Box<dyn DnsStreamHandle>>, DnsMultiplexerSerialResponse>where
    F: Future<Item = S, Error = ProtoError> + Send + 'static,
    S: DnsClientStream + Send + 'static,

pub fn new(
    stream: F,
    stream_handle: Box<dyn DnsStreamHandle>,
    signer: Option<Arc<Signer>>
) -> (Self, BasicClientHandle<DnsMultiplexerSerialResponse>)

Spawns a new ClientFuture 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 fn with_timeout(
    stream: F,
    stream_handle: Box<dyn DnsStreamHandle>,
    timeout_duration: Duration,
    signer: Option<Arc<Signer>>
) -> (Self, BasicClientHandle<DnsMultiplexerSerialResponse>)

Spawns a new ClientFuture 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

impl<F, S, R> ClientFuture<F, S, R>where
    F: Future<Item = S, Error = ProtoError> + 'static + Send,
    S: DnsRequestSender<DnsResponseFuture = R>,
    R: Future<Item = DnsResponse, Error = ProtoError> + 'static + Send,

pub fn connect(connect_future: F) -> (Self, BasicClientHandle<R>)

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 and a handle to send dns messages. Self is a background task, it must be run on an executor before handle is used.

Trait Implementations

impl<SenderFuture, Sender, Response> Future for ClientFuture<SenderFuture, Sender, Response>where
    SenderFuture: Future<Item = Sender, Error = ProtoError> + Send,
    Sender: DnsRequestSender<DnsResponseFuture = Response>,
    Response: Future<Item = DnsResponse, Error = ProtoError> + Send,

type Item = ()

The type of value that this future will resolved with if it is successful.

type Error = ()

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<Self::Item, Self::Error>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error>where
    Self: Sized,

Block the current thread until this future is resolved.

fn map<F, U>(self, f: F) -> Map<Self, F>where
    F: FnOnce(Self::Item) -> U,
    Self: Sized,

Map this future’s result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>where
    F: FnOnce(Self::Error) -> E,
    Self: Sized,

Map this future’s error to a different error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E>where
    E: From<Self::Error>,
    Self: Sized,

Map this future’s error to any error implementing From for this future’s Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F>where
    F: FnOnce(Result<Self::Item, Self::Error>) -> B,
    B: IntoFuture,
    Self: Sized,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F>where
    F: FnOnce(Self::Item) -> B,
    B: IntoFuture<Error = Self::Error>,
    Self: Sized,

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F>where
    F: FnOnce(Self::Error) -> B,
    B: IntoFuture<Item = Self::Item>,
    Self: Sized,

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future>where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>,
    Self: Sized,

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future>where
    B: IntoFuture,
    Self: Sized,

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future>where
    B: IntoFuture<Error = Self::Error>,
    Self: Sized,

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(
    self,
    b: B,
    c: C
) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future>where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    Self: Sized,

Same as join, but with more futures.

fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future>where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    Self: Sized,

Same as join, but with more futures.

fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future>where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>,
    Self: Sized,

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>where
    Self: Sized,

Convert this future into a single element stream.

fn fuse(self) -> Fuse<Self>where
    Self: Sized,

Fuse a future such that poll will never again be called once it has completed.

fn inspect<F>(self, f: F) -> Inspect<Self, F>where
    F: FnOnce(&Self::Item),
    Self: Sized,

Do something with the item of a future, passing it on.

fn shared(self) -> Shared<Self>where
    Self: Sized,

Create a cloneable handle to this future where all handles will resolve to the same result.