Skip to main content

LocalScope

Struct LocalScope 

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

Holds subscriptions whose callbacks run on this thread, when you pump.

Ordinary subscriptions hand their callback to the library, which may call it from the file watcher’s thread - so the callback has to be Send + Sync, which rules out Rc state and most GUI context handles. A local subscription instead queues the value and calls the callback from LocalScope::drain, on whichever thread drains.

The scope is neither Send nor Sync, so a callback registered here cannot reach another thread at all - not by convention, but because the type will not move.

Dropping the scope ends every subscription in it.

Implementations§

Source§

impl LocalScope

Source

pub fn new() -> Self

Source

pub fn drain(&mut self)

Delivers everything queued since the last call.

Changes a callback causes while draining are picked up by the next drain, not this one, so a callback that writes what it listens to cannot spin here.

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn clear(&mut self)

Source

pub fn changed(&self) -> Changed<'_> ⓘ

Waits until something is queued.

Delivery still happens in LocalScope::drain - this only wakes the loop that calls it:

ⓘ
loop {
    ui.changed().await;
    ui.drain();
}

Trait Implementations§

Source§

impl Default for LocalScope

Source§

fn default() -> LocalScope

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.

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