Skip to main content

ThemeSubscription

Struct ThemeSubscription 

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

RAII guard that keeps a theme watcher alive.

Holds a background thread and a shutdown channel. When dropped, the channel sender is dropped (signaling shutdown via disconnection) and the background thread is joined. On macOS it holds the notification observer instead, and dropping it removes the observer.

Note: ThemeSubscription is Send but not Sync. The background thread handle and shutdown channel are not safe to share across threads, but the guard can be moved to a different thread if needed.

§Dropping

Drop joins the watcher thread: a callback that is running when the drop starts finishes before the drop returns, and none runs after it. A callback may drop its own subscription: the drop then runs on the watcher thread, so it does not join it but detaches it, and the thread exits once the callback returns. On macOS, where there is no watcher thread, dropping removes the observer and waits for a callback already queued to finish; dropped from inside the callback, it returns without waiting, and a notification already queued can still run the callback once.

Because the drop waits for the callback, it deadlocks if a callback waits on a lock the dropping thread holds, or, on macOS, dispatches synchronously to the main thread while the main thread drops the subscription.

§Important

You must bind this to a variable. If you discard it, the watcher stops immediately:

ⓘ
// WRONG -- watcher is dropped immediately:
on_theme_change(|e| println!("{e:?}"));

// RIGHT -- watcher lives as long as `_watcher`:
let _watcher = on_theme_change(|e| println!("{e:?}")).unwrap();

Trait Implementations§

Source§

impl Debug for ThemeSubscription

Source§

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

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

impl Drop for ThemeSubscription

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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 = !

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