Struct UseIdleOptions 

pub struct UseIdleOptions {
    pub timeout: u32,
    pub listen_mouse: bool,
    pub listen_keyboard: bool,
    pub listen_scroll: bool,
    pub listen_visibility: bool,
    pub initial_idle: bool,
    pub events: Vec<Cow<'static, str>>,
}

Configuration options for the use_idle hook.

Fields

timeout: u32

The time in milliseconds after which the user is considered idle. Default: 60_000 (1 minute)

listen_mouse: bool

Whether to listen for mouse events. Default: true

listen_keyboard: bool

Whether to listen for keyboard events. Default: true

listen_scroll: bool

Whether to listen for scroll events. Default: true

listen_visibility: bool

Whether to listen for visibility change events. Default: true

initial_idle: bool

Whether to start in idle state. Default: false

events: Vec<Cow<'static, str>>

Additional events to listen for.

Trait Implementations

impl Clone for UseIdleOptions

fn clone(&self) -> UseIdleOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UseIdleOptions

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

Formats the value using the given formatter.

impl Default for UseIdleOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for UseIdleOptions

fn eq(&self, other: &UseIdleOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UseIdleOptions