Struct Stream 

pub struct Stream<A: BaseTx, E: BaseRx, S: StateMarker> { /* private fields */ }

Handle to a running worker stream.

Wraps thread join handle, cancel token, health flag, action/event channels, and shared state.

Implementations

impl<A: BaseTx, E: BaseRx, S: StateMarker> Stream<A, E, S>

pub fn new( id: Simple, handle: JoinHandle<StreamResult<()>>, health: HealthFlag, action_tx: A, event_rx: E, state: Arc<StateCell<S>>, cancel: CancelToken, ) -> Self

Construct a new stream handle from parts.

pub fn id(&self) -> &StreamId

Get typed stream id.

pub fn id_raw(&self) -> Simple

Get raw UUID value.

pub fn token(&self) -> &CancelToken

Cancellation token of the stream.

pub fn is_healthy(&self) -> bool

Check current health flag.

pub fn cancel(&self)

Request cancellation (sets health down and cancels token).

pub fn is_cancelled(&self) -> bool

Check if the cancel token is tripped.

pub fn stop(self) -> StreamResult<()>

Cancel and wait for the thread to end.

pub fn wait_to_end(self) -> StreamResult<()>

Wait for the thread to end, returning its result.

pub fn state(&self) -> &Arc<StateCell<S>>

Access shared state snapshot cell.

impl<A, E, S> Stream<A, E, S>

where A: BaseTx + TxMarker, E: BaseRx, S: StateMarker,

pub fn try_send( &mut self, action: <A as BaseTx>::EventType, ) -> Result<(), SendError<<A as BaseTx>::EventType>>

Non-blocking send of an action into the worker.

pub fn send( &mut self, action: <A as BaseTx>::EventType, timeout: Option<Duration>, ) -> Result<(), SendError<<A as BaseTx>::EventType>>

Send an action with optional timeout and cancellation.

pub fn action_tx(&self) -> &A

Borrow the action TX half.

pub fn action_tx_mut(&mut self) -> &mut A

Borrow the action TX half.

impl<A, E, S> Stream<A, E, S>

where A: BaseTx, E: BaseRx + RxMarker, S: StateMarker,

pub fn try_recv(&mut self) -> Result<E::EventType, TryRecvError>

Non-blocking receive from the worker.

pub fn recv( &mut self, timeout: Option<Duration>, ) -> Result<E::EventType, RecvError>

Blocking/cooperative receive with optional timeout.

pub fn drain(&mut self, max: usize) -> Vec<E::EventType>

Drain up to max events.

pub fn drain_max(&mut self) -> Vec<E::EventType>

Drain all currently available events.

pub fn event_rx(&self) -> &E

Borrow the event RX half.

Trait Implementations

impl<A, E, S> Debug for Stream<A, E, S>

where A: BaseTx, E: BaseRx, S: StateMarker,

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

Formats the value using the given formatter.

impl<A, E, S> Drop for Stream<A, E, S>

where A: BaseTx, E: BaseRx, S: StateMarker,

fn drop(&mut self)

Executes the destructor for this type.