Struct LogStream 

pub struct LogStream { /* private fields */ }

Receiver for the device LOG stream.

Every LogStream from one Device reads one shared queue, so each line goes to only one of them. Cloning a LogStream shares its close.

Implementations

impl LogStream

pub fn recv(&self) -> Result<LogLine>

Block until the next LOG line; Disconnected once the box disconnects or the stream is closed.

pub fn try_recv(&self) -> Option<LogLine>

Next buffered LOG line, or None if none is queued. Never blocks.

pub fn recv_timeout(&self, timeout: Duration) -> Option<LogLine>

Block up to timeout for the next LOG line; None on timeout or a closed channel.

pub fn is_connected(&self) -> bool

Whether the box still delivers to this stream. Separates the two meanings of None from Self::recv_timeout and Self::try_recv: “nothing yet” and “nothing ever again”.

pub fn try_iter(&self) -> impl Iterator<Item = LogLine> + '_

Drain buffered LOG lines without blocking.

pub async fn recv_async(&self) -> Result<LogLine>

Await the next LOG line; runtime-agnostic (same flume channel as the sync methods).

pub fn close(&self)

End this stream and every clone of it. Every blocked receive returns at once, as does every later one. Other LogStreams keep reading the queue.

For a thread that holds no handle to the stream, see Self::closer.

pub fn closer(&self) -> StreamCloser

A handle that closes this stream from any thread.

Trait Implementations

impl Clone for LogStream

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LogStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl IntoIterator for LogStream

type Item = LogLine

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = LogLine> + Send>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.