Struct IoData

Source
pub struct IoData {
    pub pins: HashMap<u8, Pin>,
    pub i2c_data: Vec<I2CReply>,
    pub digital_reported_pins: Vec<u8>,
    pub analog_reported_channels: Vec<u8>,
    pub protocol_version: String,
    pub firmware_name: String,
    pub firmware_version: String,
    pub connected: bool,
}
Expand description

Represents the internal data that a IoProtocol handles.

This struct is hidden behind an Arc<RwLock<IoData>> to allow safe concurrent access and modification through the IoData type. It encapsulates data relevant to the protocol, such as pins and I2C communication data.

Fields§

§pins: HashMap<u8, Pin>

All Pin instances, representing the hardware’s pins.

§i2c_data: Vec<I2CReply>

A vector of I2CReply instances, representing I2C communication data.

§digital_reported_pins: Vec<u8>

List pins with digital reporting activated.

§analog_reported_channels: Vec<u8>

List pins with analog reporting activated.

§protocol_version: String

A string indicating the version of the protocol.

§firmware_name: String

A string representing the name of the firmware.

§firmware_version: String

A string representing the version of the firmware.

§connected: bool

A boolean indicating whether the IoProtocol is connected.

Implementations§

Source§

impl IoData

Source

pub fn get_pin<T: Into<PinIdOrName>>(&self, pin: T) -> Result<&Pin, Error>

Returns a reference to a pin by its id or name.

§Errors
  • UnknownPin - An Error returned if the pin index is out of bounds.
Source

pub fn get_pin_mut<T: Into<PinIdOrName>>( &mut self, pin: T, ) -> Result<&mut Pin, Error>

Returns a mutable reference to a pin by its id or name.

§Errors
  • UnknownPin - An Error returned if the pin index is out of bounds.

Trait Implementations§

Source§

impl Clone for IoData

Source§

fn clone(&self) -> IoData

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IoData

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IoData

Source§

fn default() -> IoData

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for IoData

§

impl RefUnwindSafe for IoData

§

impl Send for IoData

§

impl Sync for IoData

§

impl Unpin for IoData

§

impl UnwindSafe for IoData

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.