Enum HapticPattern 

#[repr(C)]
pub enum HapticPattern {
    Selection = 0,
    ImpactLight = 1,
    ImpactMedium = 2,
    ImpactHeavy = 3,
    ImpactSoft = 4,
    ImpactRigid = 5,
    Success = 6,
    Warning = 7,
    Error = 8,
    KeyPress = 9,
    KeyRelease = 10,
    LongPress = 11,
    ContextClick = 12,
    TextHandleMove = 13,
    GestureStart = 14,
    GestureEnd = 15,
    Rise = 16,
    Fall = 17,
    Spin = 18,
}

A haptic pattern to play, named by INTENT rather than by waveform.

See the module docs for the per-platform mapping and for why this names intents instead of envelopes.

Variants

Selection = 0

A value moved to a new discrete step — a slider hitting a detent, a picker wheel advancing, a segmented control changing. The lightest thing in the vocabulary; safe to fire repeatedly during a drag.

ImpactLight = 1

A small, light collision — a lightweight object landing.

ImpactMedium = 2

A moderate collision. The sensible default for “something happened”.

ImpactHeavy = 3

A large, heavy collision — a heavyweight object landing.

ImpactSoft = 4

A dull, compliant thud — the impact of something soft. Distinguished from ImpactLight by texture, not strength.

ImpactRigid = 5

A crisp, hard tap — the impact of something inflexible. Distinguished from ImpactHeavy by texture, not strength.

Success = 6

A task completed successfully.

Warning = 7

A task completed, but something needs attention.

Error = 8

A task failed, or an action was rejected — an invalid drop target, a form that will not submit.

KeyPress = 9

A key went down on an on-screen keyboard.

KeyRelease = 10

A key came up on an on-screen keyboard.

LongPress = 11

A long press crossed its threshold and is now committed. Fire this at the MOMENT the threshold is crossed, not when the finger lifts — the whole point is to tell the user they can let go.

ContextClick = 12

A secondary/context action was invoked — a right-click, a long-press menu opening.

TextHandleMove = 13

A text selection handle moved to a new character position.

GestureStart = 14

A continuous gesture began and is now tracking.

GestureEnd = 15

A continuous gesture ended.

Rise = 16

A quick upward sweep — something growing, expanding, being picked up.

Fall = 17

A quick downward sweep — something shrinking, collapsing, being dropped.

Spin = 18

A spinning, bidirectional flutter — momentum, a wheel being flicked.

Implementations

impl HapticPattern

pub const fn fallback(self) -> Option<HapticPattern>

The next-simplest pattern to try when a backend cannot render this one.

Backends walk this chain rather than silently dropping the request, so a caller asking for Spin on a device whose actuator predates the primitive still feels something. Every chain terminates at Selection, which every haptic device on every platform can render; Selection itself returns None, which is the signal to give up.

This exists because the degradation is a property of the PATTERN, not of the backend — otherwise all six backends would each invent their own (differing) fallback and the same call would feel unrelated across platforms.

pub fn resolve( self, supported: impl Fn(HapticPattern) -> bool, ) -> Option<HapticPattern>

Walk fallback until supported accepts a pattern.

Backends call this instead of matching on the pattern twice. Returns None if nothing in the chain is supported, which means the request should be dropped.

Trait Implementations

impl Clone for HapticPattern

fn clone(&self) -> HapticPattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HapticPattern

impl Debug for HapticPattern

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

Formats the value using the given formatter.

impl Eq for HapticPattern

impl Hash for HapticPattern

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for HapticPattern

fn cmp(&self, other: &HapticPattern) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for HapticPattern

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for HapticPattern

fn partial_cmp(&self, other: &HapticPattern) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for HapticPattern