Skip to main content

SwitchManager

Struct SwitchManager 

Source
pub struct SwitchManager { /* private fields */ }
Expand description

Switch manager for obniz board switch

Implementations§

Source§

impl SwitchManager

Source

pub fn new(obniz: Obniz) -> Self

Source

pub async fn get_state(&self) -> ObnizResult<SwitchState>

Get current switch state

Source

pub async fn is_pressed(&self) -> ObnizResult<bool>

Check if switch is currently pressed (any direction)

Source

pub async fn is_pressed_direction( &self, direction: SwitchState, ) -> ObnizResult<bool>

Check if switch is pressed in specific direction

Source

pub async fn on_change<F>(&self, callback: F) -> ObnizResult<()>
where F: Fn(SwitchState, SwitchAction) + Send + Sync + 'static,

Register callback for switch state changes

Source

pub async fn on_push<F>(&self, callback: F) -> ObnizResult<()>
where F: Fn() + Send + Sync + 'static,

Register callback for push events only

Source

pub async fn on_release<F>(&self, callback: F) -> ObnizResult<()>
where F: Fn() + Send + Sync + 'static,

Register callback for release events

Source

pub async fn on_left<F>(&self, callback: F) -> ObnizResult<()>
where F: Fn() + Send + Sync + 'static,

Register callback for left direction events

Source

pub async fn on_right<F>(&self, callback: F) -> ObnizResult<()>
where F: Fn() + Send + Sync + 'static,

Register callback for right direction events

Source

pub async fn on_any_press<F>(&self, callback: F) -> ObnizResult<()>
where F: Fn(SwitchState) + Send + Sync + 'static,

Register callback for any press event (push, left, or right)

Source

pub fn remove_callback(&self) -> ObnizResult<()>

Remove switch callback

Source

pub async fn wait_for_state( &self, target_state: SwitchState, timeout_ms: Option<u64>, ) -> ObnizResult<()>

Wait for specific switch state (blocking until state is reached)

Source

pub async fn wait_for_press( &self, timeout_ms: Option<u64>, ) -> ObnizResult<SwitchState>

Wait for any press event

Source

pub async fn wait_for_release(&self, timeout_ms: Option<u64>) -> ObnizResult<()>

Wait for release event

Trait Implementations§

Source§

impl Clone for SwitchManager

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SwitchManager

Source§

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

Formats the value using the given formatter. Read more

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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, 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V