Struct comms::client::Client
[−]
[src]
pub struct Client<I, C> where
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static, { /* fields omitted */ }
Handles communication with a single server client.
This is the basic 'unit' around which comms
is constructed. It handles
communication with a single client, e.g., a single TCP socket. It stores
an ID and closes the connection if the provided Sink
or Stream
errors.
In addition this supports timeouts on receiving data. The Timeout
enum
allows specifying whether to have a timeout and whether the client should
be disconnected should the timeout not be met.
Methods
impl<I, T, R> Client<I, Unsplit<T, R>> where
I: Clone + Send + Debug + 'static,
T: Sink + 'static,
R: Stream + 'static,
[src]
I: Clone + Send + Debug + 'static,
T: Sink + 'static,
R: Stream + 'static,
fn new_from_split(id: I, tx: T, rx: R) -> Client<I, Unsplit<T, R>>
Create a new client from separate Sink
and Stream
.
Created from the ID, a Sink
and a Stream
.
impl<I, C> Client<I, C> where
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static,
[src]
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static,
fn new(id: I, tx_rx: C) -> Client<I, C>
Create a new client from a Sink + Stream
.
Created from the ID, a timeout strategy, and a Sink + Stream
.
fn id(&self) -> I
Get a clone of the client ID.
fn rename<J>(self, new_id: J) -> Client<J, C> where
J: Clone + Send + Debug + 'static,
J: Clone + Send + Debug + 'static,
Change the client's ID. The new ID can be of a different type.
fn transmit(self, msg: C::SinkItem) -> Transmit<I, C>
Future that transmits a single message.
If this succeeds the Item is a Client. If the transmission fails the Error is a Client which has dropped its connection.
handle.spawn(client.transmit('h') .and_then(|client| client.transmit('e')) .and_then(|client| client.transmit('l')) .and_then(|client| client.transmit('l')) .and_then(|client| client.transmit('o')) .map(|client| println!("sent hello to {}.", client.id()); ()) .map_err(|client| println!("sending hello to {} failed.", client.id()); ()));
fn receive(self) -> Receive<I, C>
Future that tries to receive a single message.
fn is_connected(&self) -> bool
Is the client connected?
fn is_disconnected(&self) -> Option<&Disconnect<C::SinkError, C::Error>>
Get disconnection cause if the client is disconnected.
fn close(&mut self) -> bool
Force the Client to disconnect if a connection is active.
Returns whether an active connection was disconnected.
fn into_inner(self) -> (I, Result<C, Disconnect<C::SinkError, C::Error>>)
Retrieve the client ID and the current state of the connection.
Trait Implementations
impl<I: Debug, C: Debug> Debug for Client<I, C> where
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static,
C::SinkError: Debug,
C::Error: Debug,
[src]
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static,
C::SinkError: Debug,
C::Error: Debug,
impl<I: Clone, C: Clone> Clone for Client<I, C> where
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static,
C::SinkError: Clone,
C::Error: Clone,
[src]
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static,
C::SinkError: Clone,
C::Error: Clone,
fn clone(&self) -> Client<I, C>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl<I, C> Stream for Client<I, C> where
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static,
[src]
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static,
type Item = C::Item
The type of item this stream will yield on success.
type Error = ()
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. Read more
fn wait(self) -> Wait<Self>
Creates an iterator which blocks the current thread until each item of this stream is resolved. Read more
fn boxed(
self
) -> Box<Stream<Error = Self::Error, Item = Self::Item> + 'static + Send> where
Self: Send + 'static,
self
) -> Box<Stream<Error = Self::Error, Item = Self::Item> + 'static + Send> where
Self: Send + 'static,
Convenience function for turning this stream into a trait object. Read more
fn into_future(self) -> StreamFuture<Self>
Converts this stream into a Future
. Read more
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> U,
F: FnMut(Self::Item) -> U,
Converts a stream of type T
to a stream of type U
. Read more
fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
F: FnMut(Self::Error) -> U,
F: FnMut(Self::Error) -> U,
Converts a stream of error type T
to a stream of error type U
. Read more
fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,
F: FnMut(&Self::Item) -> bool,
Filters the values produced by this stream according to the provided predicate. Read more
fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,
F: FnMut(Self::Item) -> Option<B>,
Filters the values produced by this stream while simultaneously mapping them to a different type. Read more
fn then<F, U>(self, f: F) -> Then<Self, F, U> where
F: FnMut(Result<Self::Item, Self::Error>) -> U,
U: IntoFuture,
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
. Read more
fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Error = Self::Error>,
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
. Read more
fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
F: FnMut(Self::Error) -> U,
U: IntoFuture<Item = Self::Item>,
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
. Read more
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. Read more
fn concat2(self) -> Concat2<Self> where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: Default,
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. Read more
fn concat(self) -> Concat<Self> where
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
Self::Item: IntoIterator,
: please use Stream::concat2
instead
Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more
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>,
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. Read more
fn flatten(self) -> Flatten<Self> where
Self::Item: Stream,
<Self::Item as Stream>::Error: From<Self::Error>,
Self::Item: Stream,
<Self::Item as Stream>::Error: From<Self::Error>,
Flattens a stream of streams into just one continuous stream. Read more
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>,
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Skip elements on this stream while the predicate provided resolves to true
. Read more
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>,
P: FnMut(&Self::Item) -> R,
R: IntoFuture<Item = bool, Error = Self::Error>,
Take elements from this stream while the predicate provided resolves to true
. Read more
fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
F: FnMut(Self::Item) -> U,
U: IntoFuture<Item = (), Error = Self::Error>,
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. Read more
fn from_err<E>(self) -> FromErr<Self, E> where
E: From<Self::Error>,
E: From<Self::Error>,
Map this stream's error to any error implementing From
for this stream's Error
, returning a new stream. Read more
fn take(self, amt: u64) -> Take<Self>
Creates a new stream of at most amt
items of the underlying stream. Read more
fn skip(self, amt: u64) -> Skip<Self>
Creates a new stream which skips amt
items of the underlying stream. Read more
fn fuse(self) -> Fuse<Self>
Fuse a stream such that poll
will never again be called once it has finished. Read more
fn by_ref(&mut self) -> &mut Self
Borrows a stream, rather than consuming it. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
Self: UnwindSafe,
Catches unwinding panics while polling the stream. Read more
fn buffered(self, amt: usize) -> Buffered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error,
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error,
An adaptor for creating a buffered list of pending futures. Read more
fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error,
Self::Item: IntoFuture,
<Self::Item as IntoFuture>::Error == Self::Error,
An adaptor for creating a buffered list of pending futures (unordered). Read more
fn merge<S>(self, other: S) -> Merge<Self, S> where
S: Stream<Error = Self::Error>,
S: Stream<Error = Self::Error>,
An adapter for merging the output of two streams. Read more
fn zip<S>(self, other: S) -> Zip<Self, S> where
S: Stream<Error = Self::Error>,
S: Stream<Error = Self::Error>,
An adapter for zipping two streams together. Read more
fn chain<S>(self, other: S) -> Chain<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>,
S: Stream<Item = Self::Item, Error = Self::Error>,
Adapter for chaining two stream. Read more
fn peekable(self) -> Peekable<Self>
Creates a new stream which exposes a peek
method. Read more
fn chunks(self, capacity: usize) -> Chunks<Self>
An adaptor for chunking up items of the stream inside a vector. Read more
fn select<S>(self, other: S) -> Select<Self, S> where
S: Stream<Item = Self::Item, Error = Self::Error>,
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. Read more
fn forward<S>(self, sink: S) -> Forward<Self, S> where
S: Sink<SinkItem = Self::Item>,
Self::Error: From<<S as Sink>::SinkError>,
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. Read more
fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
Self: Sink,
Self: Sink,
Splits this Stream + Sink
object into separate Stream
and Sink
objects. Read more
impl<I, C> Sink for Client<I, C> where
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static,
[src]
I: Clone + Send + Debug + 'static,
C: Sink + Stream + 'static,
type SinkItem = C::SinkItem
The type of value that the sink accepts.
type SinkError = ()
The type of value produced by the sink when an error occurs.
fn start_send(
&mut self,
item: Self::SinkItem
) -> StartSend<Self::SinkItem, Self::SinkError>
&mut self,
item: Self::SinkItem
) -> StartSend<Self::SinkItem, Self::SinkError>
Begin the process of sending a value to the sink. Read more
fn poll_complete(&mut self) -> Poll<(), Self::SinkError>
Flush all output from this sink, if necessary. Read more
fn close(&mut self) -> Result<Async<()>, Self::SinkError>
A method to indicate that no more values will ever be pushed into this sink. Read more
fn wait(self) -> Wait<Self>
Creates a new object which will produce a synchronous sink. Read more
fn with<U, F, Fut>(self, f: F) -> With<Self, U, F, Fut> where
F: FnMut(U) -> Fut,
Fut: IntoFuture<Item = Self::SinkItem>,
<Fut as IntoFuture>::Error: From<Self::SinkError>,
F: FnMut(U) -> Fut,
Fut: IntoFuture<Item = Self::SinkItem>,
<Fut as IntoFuture>::Error: From<Self::SinkError>,
Composes a function in front of the sink. Read more
fn sink_map_err<F, E>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::SinkError) -> E,
F: FnOnce(Self::SinkError) -> E,
Transforms the error returned by the sink.
fn sink_from_err<E>(self) -> SinkFromErr<Self, E> where
E: From<Self::SinkError>,
E: From<Self::SinkError>,
Map this sink's error to any error implementing From
for this sink's Error
, returning a new sink. Read more
fn buffer(self, amt: usize) -> Buffer<Self>
Adds a fixed-size buffer to the current sink. Read more
fn flush(self) -> Flush<Self>
A future that completes when the sink has finished processing all pending requests. Read more
fn send(self, item: Self::SinkItem) -> Send<Self>
A future that completes after the given item has been fully processed into the sink, including flushing. Read more
fn send_all<S>(self, stream: S) -> SendAll<Self, S> where
S: Stream<Item = Self::SinkItem>,
Self::SinkError: From<<S as Stream>::Error>,
S: Stream<Item = Self::SinkItem>,
Self::SinkError: From<<S as Stream>::Error>,
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
impl<I, C> PartialEq for Client<I, C> where
I: Clone + Send + Debug + PartialEq + 'static,
C: Sink + Stream + 'static,
[src]
I: Clone + Send + Debug + PartialEq + 'static,
C: Sink + Stream + 'static,
fn eq(&self, other: &Client<I, C>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0
This method tests for !=
.
impl<I, C> Eq for Client<I, C> where
I: Clone + Send + Debug + PartialEq + Eq + 'static,
C: Sink + Stream + 'static,
[src]
I: Clone + Send + Debug + PartialEq + Eq + 'static,
C: Sink + Stream + 'static,