Struct HapticPattern 

pub struct HapticPattern { /* private fields */ }

A vibration waveform: alternating durations with a target amplitude each.

This is Android’s VibrationEffect.createWaveform(long[], int[], int) in framework terms. Index 0 is an off period by convention (its amplitude is usually 0), then on, then off — but nothing enforces that, so an app is free to shape a ramp out of consecutive non-zero amplitudes.

Amplitudes run 0 (off) to 255 (the device’s strongest). Devices without amplitude control treat any non-zero amplitude as full strength; check Haptics::has_amplitude_control before designing around subtle levels.

Implementations

impl HapticPattern

pub const MAX_STEPS: usize = 512

The longest waveform the framework passes to a platform vibrator. Android’s own limit is device-defined and far lower in practice; this bound keeps a malformed pattern from reaching JNI at all.

pub fn new( timings_ms: &[u32], amplitudes: &[u8], ) -> Result<HapticPattern, HapticError>

Builds a one-shot waveform.

Fails when the two slices differ in length, when there are no steps, or when every timing is zero.

pub fn repeating( timings_ms: &[u32], amplitudes: &[u8], repeat_index: usize, ) -> Result<HapticPattern, HapticError>

Builds a waveform that loops back to repeat_index until Haptics::cancel stops it.

pub fn timings_ms(&self) -> &[u32]

The per-step durations in milliseconds.

pub fn amplitudes(&self) -> &[u8]

The per-step amplitudes, 0 to 255.

pub fn repeat(&self) -> Option<usize>

The index the waveform loops back to, if it repeats.

pub fn len(&self) -> usize

How many steps the waveform has.

pub fn is_empty(&self) -> bool

Always false: a pattern cannot be built with no steps.

pub fn total_duration_ms(&self) -> u32

One pass through the waveform, in milliseconds.

pub fn peak_amplitude(&self) -> u8

The strongest amplitude in the waveform, which is what a backend without waveform support falls back on.

pub fn closest_feedback(&self) -> HapticFeedback

The closest HapticFeedback constant for this pattern, derived from its strength and length. Backends without waveform support use it.

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 Debug for HapticPattern

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

Formats the value using the given formatter.

impl Eq for HapticPattern

impl PartialEq for HapticPattern

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HapticPattern