Struct trust_dns::client::ClientFuture

#[must_use = "futures do nothing unless polled"]
pub struct ClientFuture<S: Stream<Item = Vec<u8>, Error = Error>> { /* fields omitted */ }

A DNS Client implemented over futures-rs.

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

Methods

impl<S: Stream<Item = Vec<u8>, Error = Error> + 'static> ClientFuture<S>

fn new(
    stream: Box<Future<Item = S, Error = Error>>,
    stream_handle: Box<ClientStreamHandle>,
    loop_handle: Handle,
    signer: Option<Signer>
) -> BasicClientHandle

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)
• loop_handle - A Handle to the Tokio reactor Core, this is the Core on which the the Stream will be spawned
• 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

fn with_timeout(
    stream: Box<Future<Item = S, Error = Error>>,
    stream_handle: Box<ClientStreamHandle>,
    loop_handle: Handle,
    timeout_duration: Duration,
    signer: Option<Signer>
) -> BasicClientHandle

Spawns a new ClientFuture Stream.

Arguments

• stream - A stream of bytes that can be used to send/receive DNS messages (see TcpClientStream or UdpClientStream)
• loop_handle - A Handle to the Tokio reactor Core, this is the Core on which the the Stream will be spawned
• 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

Trait Implementations

impl<S: Stream<Item = Vec<u8>, Error = Error> + 'static> Future for ClientFuture<S>

type Item = ()

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

type Error = ClientError

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

fn poll(&mut self) -> Poll<(), 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>

Block the current thread until this future is resolved.

fn boxed(
    self
) -> Box<Future<Error = Self::Error, Item = Self::Item> + 'static + Send> where
    Self: Send + 'static, 

Convenience function for turning this future into a trait object which is also Send.

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

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, 

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>, 

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
    B: IntoFuture,
    F: FnOnce(Result<Self::Item, Self::Error>) -> B, 

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
    B: IntoFuture<Error = Self::Error>,
    F: FnOnce(Self::Item) -> B, 

Execute another future after this one has resolved successfully.

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

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>, 

Waits for either one of two futures to complete.

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

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>, 

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>, 

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>, 

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>, 

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>, 

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error == Self::Error, 

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self>

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

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

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