Skip to main content

MaterialHaptics

Struct MaterialHaptics 

Source
pub struct MaterialHaptics;
Expand description

The design system’s pluggable, process-global haptics seam. Carries no state of its own — every method is a plain associated function over one process-wide hook cell. See the module docs for why this crate reaches no frust-haptics dependency itself.

Implementations§

Source§

impl MaterialHaptics

Source

pub fn set(hook: fn(HapticSignal)) -> bool

Install the process-wide haptics hook.

Timing contract: intended to be called once, from an app’s own install()-era setup (mirroring how crate::install seeds the default theme) — before any widget can call Self::fire. The underlying cell is set-once: the first successful call wins, and every later call is rejected outright — a hook swap (last-wins) is deliberately not supported, so there is no way to uninstall or replace a hook once one has won. Returns true iff this call installed the hook, false if a hook was already installed and this one was rejected.

§Wiring to frust-haptics

frust-material never depends on frust-haptics (or any other plugin) itself — the design-system charter forbids a plugin-tier crate depending on a sibling plugin (docs/PLUGINS_ARCHITECTURE.md’s Layer Dependencies). An app that wants real haptic feedback depends on frust-haptics itself and wires it here — this example is ignored (not no_run) because frust-haptics is intentionally absent from this crate’s own dependency graph, including as a dev-dependency, so it cannot compile in this doctest:

ⓘ
// In the app's own crate — frust-haptics is *its* dependency, never
// frust-material's.
fn install_haptics() {
    frust_material::MaterialHaptics::set(|signal| {
        use frust_material::HapticSignal;
        use frust_haptics::{HapticEffect, Haptics};
        let effect = match signal {
            HapticSignal::None => return,
            HapticSignal::Light => HapticEffect::ImpactLight,
            HapticSignal::Medium => HapticEffect::ImpactMedium,
            HapticSignal::Heavy => HapticEffect::ImpactHeavy,
            HapticSignal::SliderTick => HapticEffect::SelectionClick,
        };
        let _ = Haptics::perform(effect);
    });
}
Source

pub fn fire(signal: HapticSignal)

Fire signal through the installed hook — a silent no-op if none has been installed yet (the default; see the module docs).

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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