Skip to main content

Held

Struct Held 

Source
pub struct Held {
    conversation: Mutex<Conversation>,
    folded: Condvar,
}
Expand description

One seat’s conversation, and the fold that may be running over it.

Two locks, because a fold must not be held against the stream and a reader must not see half of one. A fold takes the messages out in O(1) under the mutex, renders them outside it - so the socket’s single stream folder never waits on a render - and puts them back under the mutex with the spans. Between those two the seat holds no messages and the PREVIOUS fold’s boundaries, and a page sliced on those walks off the end of an empty list.

So the mutex is paired with a condvar: a reader waits out a fold in progress rather than looking at it. The wait is on the reader’s own blocking task, and it is bounded by one render.

Fields§

§conversation: Mutex<Conversation>§folded: Condvar

Implementations§

Source§

impl Held

Source

pub fn new(conversation: Conversation) -> Self

Source

pub fn holds_occupant(&self, occupant: Option<&SessionId>) -> bool

Whether this copy belongs to the seat’s current occupant.

A copy with no occupant matches anything, and so does a header naming nobody: a transcript that named no session seeds a copy with no occupant, and a sleeping seat’s header names no run - neither is discarded for lacking a fact nothing ever recorded.

Source

pub fn lock(&self) -> MutexGuard<'_, Conversation>

The conversation, waiting out a fold that is running over it.

Source

fn install(&self, window: Window, rendered: Rendered, complete: bool)

Put a fold’s result back and wake every reader waiting on it.

Source

pub fn read<T>(&self, read: impl FnOnce(&Conversation) -> T) -> T

Fold if needed, then read, retrying once if a reseed landed in between.

Two acquisitions, and the gap between them is why this retries. A Connected or a /resume can replace the conversation between the fold and the read, and what a reader then holds is the new messages against boundaries the fold cleared - one turn covering the whole conversation rather than a window of them. The retry closes the common case; a second reseed inside the second window still gets through, which is stated in the PR rather than claimed away.

Source

pub fn fold(&self)

Fold if the messages moved, outside the lock and off the reactor.

The caller is a blocking task that has nothing else to do with the conversation until this returns.

Auto Trait Implementations§

§

impl !Freeze for Held

§

impl RefUnwindSafe for Held

§

impl Send for Held

§

impl Sync for Held

§

impl Unpin for Held

§

impl UnsafeUnpin for Held

§

impl UnwindSafe for Held

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
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

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
§

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

§

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

§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

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
§

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
§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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