Skip to main content

DetectionContext

Struct DetectionContext 

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

Process-wide detection cache.

Provides “cache on first read” semantics for OS detection queries (is_dark, reduced_motion, icon_theme, linux_desktop) and per-field invalidation for watchers that need fresh data.

Obtain the process-wide instance via system().

§Thread Safety

All reads and invalidations are lock-free (backed by arc_swap::ArcSwapOption).

Implementations§

Source§

impl DetectionContext

Source

pub fn is_dark(&self) -> bool

Whether the system is using a dark color scheme (cached).

The first call queries the OS and caches the result. Subsequent calls return the cached value. Call invalidate_is_dark() to force a re-read on the next call.

Source

pub fn prefers_reduced_motion(&self) -> bool

Whether the user prefers reduced motion (cached).

The first call queries the OS and caches the result. Call invalidate_reduced_motion() to force a re-read.

Source

pub fn icon_theme(&self) -> Result<String>

The current icon theme name (cached), or why none was detected.

The first call detects the theme from the OS and caches the outcome, a failure included, so a failed detection is not repeated on every call; subsequent calls return the cached outcome. Call invalidate_icon_theme() to force a re-read.

§Errors

As system_icon_theme(): no theme stands in for one that could not be detected.

Source

pub fn linux_desktop(&self) -> LinuxDesktop

The current Linux desktop environment (cached).

The first call reads XDG_CURRENT_DESKTOP and caches the result. Call invalidate_linux_desktop() to force a re-read.

Source

pub fn invalidate_is_dark(&self)

Clear the cached dark-mode value.

Source

pub fn invalidate_reduced_motion(&self)

Clear the cached reduced-motion value.

Source

pub fn invalidate_icon_theme(&self)

Clear the cached icon theme, or the cached failure to detect one.

Source

pub fn invalidate_linux_desktop(&self)

Clear the cached Linux desktop environment.

Source

pub fn invalidate_all(&self)

Clear all cached values.

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