[][src]Struct tokio_resol_vbus::LiveDataStream

pub struct LiveDataStream<R: AsyncRead, W: AsyncWrite> { /* fields omitted */ }

A Stream/Sink wrapper for RESOL VBus Data items encoded in the live / wire representation.

It also contains methods to communicate with a VBus device to get or set values etc.

Methods

impl<R: AsyncRead, W: AsyncWrite> LiveDataStream<R, W>
[src]

Create a new LiveDataStream.

Consume self and return the underlying I/O pair.

Receive data from the VBus.

This methods waits for timeout_ms milliseconds for incoming VBus data. Every time a valid Data is received over the VBus the filter function is called with that Data as its argument. The function returns a bool whether the provided Data is the data it was waiting for.

If the filter function returns true, the respective Data is used to resolve the receive method's Future.

If the filter function did not find the matching data within timeout_ms milliseconds, the receive method's Future resolves with (self, None).

Send data to the VBus and wait for a reply.

This method sends the tx_data to the VBus and waits for up to initial_timeout_ms milliseconds for a reply.

Every time a valid Data is received over the VBus the filter function is called with that Data as its argument. The function returns a bool whether the provided Data is the reply it was waiting for.

If the filter function returns true, the respective Data is used to resolve the transceive method's Future.

If the filter function did not find the matching reply within initial_timeout_ms milliseconds, the tx_data is send again up max_tries times, increasing the timeout by timeout_increment_ms milliseconds every time.

After max_tries without a matching reply the transceive method's Future resolves with (self, None).

Wait for any VBus data.

Wait for a datagram that offers VBus control.

Give back bus control to the regular VBus master.

Get a value by its index.

Set a value by its index.

Get a value's ID hash by its index.

Get a value's index by its ID hash.

Get the capabilities (part 1) from a VBus device.

Begin a bulk value transaction.

Commit a bulk value transaction.

Rollback a bulk value transaction.

Set a value by its index while inside a bulk value transaction.

Trait Implementations

impl<R: Debug + AsyncRead, W: Debug + AsyncWrite> Debug for LiveDataStream<R, W>
[src]

impl<R: AsyncRead, W: AsyncWrite> Stream for LiveDataStream<R, W>
[src]

The type of item this stream will yield on success.

The type of error this stream may generate.

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

Converts this stream into a Future. Read more

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

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

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

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

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

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

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

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

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

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. Read more

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

Flattens a stream of streams into just one continuous stream. Read more

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

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

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

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

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

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

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

Borrows a stream, rather than consuming it. Read more

Catches unwinding panics while polling the stream. Read more

An adaptor for creating a buffered list of pending futures. Read more

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

Deprecated

: functionality provided by select now

An adapter for merging the output of two streams. Read more

An adapter for zipping two streams together. Read more

Adapter for chaining two stream. Read more

Creates a new stream which exposes a peek method. Read more

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

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

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

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

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

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

impl<R: AsyncRead, W: AsyncWrite> Sink for LiveDataStream<R, W>
[src]

The type of value that the sink accepts.

The type of value produced by the sink when an error occurs.

A method to indicate that no more values will ever be pushed into this sink. Read more

Creates a new object which will produce a synchronous sink. Read more

Composes a function in front of the sink. Read more

Composes a function in front of the sink. Read more

Transforms the error returned by the sink.

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

Adds a fixed-size buffer to the current sink. Read more

Fanout items to multiple sinks. Read more

A future that completes when the sink has finished processing all pending requests. Read more

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

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

Auto Trait Implementations

impl<R, W> Send for LiveDataStream<R, W> where
    R: Send,
    W: Send

impl<R, W> Sync for LiveDataStream<R, W> where
    R: Sync,
    W: Sync

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> StreamExt for T where
    T: Stream + ?Sized
[src]

Throttle down the stream by enforcing a fixed delay between items. Read more

Creates a new stream which allows self until timeout. Read more

impl<T> Erased for T