Struct ReceiverState

struct ReceiverState<T: Debug + Send + 'static, C: ChannelSpec> {
    rx: StreamUnobtrusivePeeker<C::Receiver<Entry<T>>>,
    mq: TypedParticipation<Entry<T>>,
    collapse_callbacks: Vec<CollapseCallback>,
}

Mutable state of a Receiver

Normally the mutex is only locked by the receiving task. On memory pressure, mutex is acquired by the memory system, which has a clone of the Arc<ReceiverInner>.

Within Arc<Mutex<Result<, >>>.

Fields

rx: StreamUnobtrusivePeeker<C::Receiver<Entry<T>>>

The inner stream, but with an unobtrusive peek for getting the oldest data age

mq: TypedParticipation<Entry<T>>

The Participation, which we use for memory accounting

Performance and locality

We have separate Participations for rx and tx. The tx is constantly claiming and the rx releasing; at least each MAX_CACHE, they must balance out via the (fairly globally shared) MemoryQuotaTracker.

If this turns out to be a problem, we could arrange to share a Participation.

collapse_callbacks: Vec<CollapseCallback>

Hooks passed to Receiver::register_collapse_hook

When receiver dropped, or memory reclaimed, we call all of these.

Trait Implementations

impl<T: Debug + Send + 'static, C: ChannelSpec> Debug for ReceiverState<T, C>

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

Formats the value using the given formatter.

impl<T: Debug + Send + 'static, C: ChannelSpec> Drop for ReceiverState<T, C>

fn drop(&mut self)

Executes the destructor for this type.