Struct trust_dns_proto::xfer::dns_multiplexer::DnsMultiplexer

#[must_use = "futures do nothing unless polled"]
pub struct DnsMultiplexer<S, MF, D = Box<dyn DnsStreamHandle>> where
    D: Send + 'static,
    S: DnsClientStream + 'static,
    MF: MessageFinalizer,  { /* 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. This should be used for underlying protocols that do not natively support multi-plexed sessions.

Methods

impl<S, MF> DnsMultiplexer<S, MF, Box<dyn DnsStreamHandle>> where
    S: DnsClientStream + 'static,
    MF: MessageFinalizer, 

pub fn new<F>(
    stream: F,
    stream_handle: Box<dyn DnsStreamHandle>,
    signer: Option<Arc<MF>>
) -> DnsMultiplexerConnect<F, S, MF> where
    F: Future<Item = S, Error = ProtoError> + Send + 'static, 

Spawns a new DnsMultiplexer 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<F>(
    stream: F,
    stream_handle: Box<dyn DnsStreamHandle>,
    timeout_duration: Duration,
    signer: Option<Arc<MF>>
) -> DnsMultiplexerConnect<F, S, MF> where
    F: Future<Item = S, Error = ProtoError> + Send + 'static, 

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

Trait Implementations

impl<S, MF> DnsRequestSender for DnsMultiplexer<S, MF> where
    S: DnsClientStream + 'static,
    MF: MessageFinalizer + Send + Sync + 'static, 

type DnsResponseFuture = DnsMultiplexerSerialResponse

A future that resolves to a response serial message

fn send_message(&mut self, request: DnsRequest) -> Self::DnsResponseFuture

Send a message, and return a future of the response

fn error_response(error: ProtoError) -> Self::DnsResponseFuture

Constructs an error response

fn shutdown(&mut self)

Allows the upstream user to inform the underling stream that it should shutdown.

fn is_shutdown(&self) -> bool

Returns true if the stream has been shutdown with shutdown

impl<S, MF> Display for DnsMultiplexer<S, MF> where
    S: DnsClientStream + 'static,
    MF: MessageFinalizer + Send + Sync + 'static, 

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<S, MF> Stream for DnsMultiplexer<S, MF> where
    S: DnsClientStream + 'static,
    MF: MessageFinalizer + Send + Sync + 'static, 

type Item = ()

The type of item this stream will yield on success.

type Error = ProtoError

The type of error this stream may generate.

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

Attempt to pull out the next value of this stream, returning None if the stream is finished.

fn wait(self) -> Wait<Self>

Creates an iterator which blocks the current thread until each item of this stream is resolved.

fn into_future(self) -> StreamFuture<Self>

Converts this stream into a Future.

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

Converts a stream of type T to a stream of type U.

fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> U, 

Converts a stream of error type T to a stream of error type U.

fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool, 

Filters the values produced by this stream according to the provided predicate.

fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 

Filters the values produced by this stream while simultaneously mapping them to a different type.

fn then<F, U>(self, f: F) -> Then<Self, F, U> where
    F: FnMut(Result<Self::Item, Self::Error>) -> U,
    U: IntoFuture, 

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f.

fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Error = Self::Error>, 

Chain on a computation for when a value is ready, passing the successful results to the provided closure f.

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

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f.

fn collect(self) -> Collect<Self>

Collect all of the values of this stream into a vector, returning a future representing the result of that computation.

fn concat2(self) -> Concat2<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default, 

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator, 

Deprecated since 0.1.14:

please use Stream::concat2 instead

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: IntoFuture<Item = T>,
    Self::Error: From<<Fut as IntoFuture>::Error>, 

Execute an accumulating computation over a stream, collecting all the values into one final result.

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

Flattens a stream of streams into just one continuous stream.

fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, 

Skip elements on this stream while the predicate provided resolves to true.

fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, 

Take elements from this stream while the predicate provided resolves to true.

fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Item = (), Error = Self::Error>, 

Runs this stream to completion, executing the provided closure for each element on the stream.

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

Map this stream's error to any error implementing From for this stream's Error, returning a new stream.

fn take(self, amt: u64) -> Take<Self>

Creates a new stream of at most amt items of the underlying stream.

fn skip(self, amt: u64) -> Skip<Self>

Creates a new stream which skips amt items of the underlying stream.

fn fuse(self) -> Fuse<Self>

Fuse a stream such that poll will never again be called once it has finished.

fn by_ref(&mut self) -> &mut Self

Borrows a stream, rather than consuming it.

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

Catches unwinding panics while polling the stream.

fn buffered(self, amt: usize) -> Buffered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, 

An adaptor for creating a buffered list of pending futures.

fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, 

An adaptor for creating a buffered list of pending futures (unordered).

fn merge<S>(self, other: S) -> Merge<Self, S> where
    S: Stream<Error = Self::Error>, 

Deprecated:

functionality provided by select now

An adapter for merging the output of two streams.

fn zip<S>(self, other: S) -> Zip<Self, S> where
    S: Stream<Error = Self::Error>, 

An adapter for zipping two streams together.

fn chain<S>(self, other: S) -> Chain<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 

Adapter for chaining two stream.

fn peekable(self) -> Peekable<Self>

Creates a new stream which exposes a peek method.

fn chunks(self, capacity: usize) -> Chunks<Self>

An adaptor for chunking up items of the stream inside a vector.

fn select<S>(self, other: S) -> Select<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first.

fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<SinkItem = Self::Item>,
    Self::Error: From<<S as Sink>::SinkError>, 

A future that completes after the given stream has been fully processed into the sink, including flushing.

fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
    Self: Sink, 

Splits this Stream + Sink object into separate Stream and Sink objects.

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

Do something with each item of this stream, afterwards passing it on.

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error), 

Do something with the error of this stream, afterwards passing it on.