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, accessibility_preferences, icon_theme,
linux_desktop, the font DPI) 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). A value detected while an invalidation of
its field lands is returned to its caller but not cached.
Implementations§
Source§impl DetectionContext
impl DetectionContext
Sourcepub fn is_dark(&self) -> bool
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.
Sourcepub fn prefers_reduced_motion(&self) -> bool
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.
Sourcepub fn accessibility_preferences(&self) -> AccessibilityPreferences
pub fn accessibility_preferences(&self) -> AccessibilityPreferences
The OS accessibility preferences (cached), as
accessibility_preferences()
describes: the platform reader’s accessibility block, run on the
first call unless a system read stored it.
Call
invalidate_accessibility_preferences()
to force a re-read.
Sourcepub fn icon_theme(&self) -> Result<String>
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.
Sourcepub fn linux_desktop(&self) -> LinuxDesktop
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.
Sourcepub fn refined_linux_desktop_sync(&self) -> LinuxDesktop
pub fn refined_linux_desktop_sync(&self) -> LinuxDesktop
The desktop the platform readers use: the raw XDG_CURRENT_DESKTOP
(linux_desktop()) where it names a desktop;
for LinuxDesktop::Unknown, the desktop the portal backend named at
the last system read (SystemTheme::from_system, from_system_async,
AccessibilityPreferences::from_system, with the portal feature),
else KDE where the user’s kdeglobals exists (with the kde
feature), else Unknown. The reader, the theme watcher, the icon-theme
detection and the font DPI decide by it, and the icon enums
native-theme-build generates pick their per-desktop names by it.
A system read caches the desktop it refined; until one has, this call
does not ask the portal and caches nothing, so on an unrecognised
desktop whose portal backend names one it can differ from what the
next system read caches (a KDE backend without kdeglobals is
Unknown here, a GNOME backend with kdeglobals is KDE here); the
system read then clears the font DPI, icon theme, dark mode and
reduced motion detected from this desktop.
invalidate_linux_desktop() clears
the cached desktop.
Sourcepub fn invalidate_is_dark(&self)
pub fn invalidate_is_dark(&self)
Clear the cached dark-mode value.
Sourcepub fn invalidate_reduced_motion(&self)
pub fn invalidate_reduced_motion(&self)
Clear the cached reduced-motion value.
Sourcepub fn invalidate_accessibility_preferences(&self)
pub fn invalidate_accessibility_preferences(&self)
Clear the cached accessibility preferences.
Sourcepub fn invalidate_icon_theme(&self)
pub fn invalidate_icon_theme(&self)
Clear the cached icon theme, or the cached failure to detect one.
Sourcepub fn invalidate_font_dpi(&self)
pub fn invalidate_font_dpi(&self)
Clear the cached font DPI.
Sourcepub fn invalidate_linux_desktop(&self)
pub fn invalidate_linux_desktop(&self)
Clear the cached Linux desktop environment, and the desktop refined from it.
Sourcepub fn invalidate_all(&self)
pub fn invalidate_all(&self)
Clear all cached values.