Skip to main content

MergedEvents

Struct MergedEvents 

Source
pub struct MergedEvents<T> { /* private fields */ }
Expand description

The host’s end of a fan-in: every tagged sink’s events, in arrival order.

§When the stream ends

recv returns None once every sink minted from the fan-in has been dropped, and not before.

The sharp edge is that a run gives its sink back: a finished run yields a RunReport with the sink in it, so a report held is a branch of the stream held open, even though that run has nothing left to say. A host that awaits its runs and its consumer in one tokio::join! must let the reports go inside the branch that produced them — take the final message, the outcome, whatever it wanted — or the join will wait on a stream that is waiting on the join.

The other shape has no edge at all: fan out, join the runs, and then drain what arrived. Nothing was lost while nobody was reading, because the queue is unbounded.

Implementations§

Source§

impl<T> MergedEvents<T>

Source

pub async fn recv(&mut self) -> Option<TaggedEvent<T>>

The next event from any run, or None once every sink is gone.

Cancel-safe, so this composes with tokio::select! as well as with a plain while let loop.

Source

pub fn blocking_recv(&mut self) -> Option<TaggedEvent<T>>

recv for a consumer that is not on an async task — a dedicated thread driving a terminal UI, or a test.

Panics if called from async code, which is tokio’s rule for blocking on a channel and the reason recv exists.

Source

pub fn drain(&mut self) -> Vec<TaggedEvent<T>>

Everything that has already arrived, without waiting for more.

What a host reads after joining its runs, and what a UI that repaints on its own schedule reads each frame. An empty result means nothing has arrived yet — it does not mean the stream is over, which only recv can say.

Trait Implementations§

Source§

impl<T> Debug for MergedEvents<T>

Hand-written to match EventFanIn’s: printable without a T: Debug.

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for MergedEvents<T>

§

impl<T> RefUnwindSafe for MergedEvents<T>

§

impl<T> Send for MergedEvents<T>
where T: Send,

§

impl<T> Sync for MergedEvents<T>
where T: Send,

§

impl<T> Unpin for MergedEvents<T>

§

impl<T> UnsafeUnpin for MergedEvents<T>

§

impl<T> UnwindSafe for MergedEvents<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more