Skip to main content

TickCallbackRegistry

Struct TickCallbackRegistry 

Source
pub struct TickCallbackRegistry { /* private fields */ }
Expand description

Registry of mode-contributed per-tick drain closures.

Stored behind an Arc and shared by reference: the host calls run_all once per tick; modes register during Mode::on_activate and unregister via the returned TickCallbackRegistration token’s Drop.

Implementations§

Source§

impl TickCallbackRegistry

Source

pub fn new() -> Self

Construct an empty registry.

Source

pub fn register( self: &Arc<Self>, callback: TickCallback, ) -> TickCallbackRegistration

Register a per-tick drain closure. Returns an RAII registration token; dropping it removes the closure. Modes accumulate the token in their Guard so deactivation drops it and the per-tick drain stops naturally.

Source

pub fn run_all(&self) -> Vec<Effect>

Run every registered callback once, in registration order, and return the concatenated Effects for the host to apply. Called once per editor tick from Editor::run_tick_pending.

Holds the lock for the duration: a callback MUST NOT call register / drop a TickCallbackRegistration on this same registry from inside its body (it would deadlock). Drain closures only ever touch their own channel + return effects, so this is a documented non-constraint in practice.

Trait Implementations§

Source§

impl Debug for TickCallbackRegistry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TickCallbackRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

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