Struct hap::characteristic::Characteristic

pub struct Characteristic<T: Debug + Default + Clone + Serialize + Send + Sync> { /* fields omitted */ }

A characteristic. A characteristic is a feature that represents data or an associated behavior of a service. The characteristic is defined by a universally unique type, and has additional properties that determine how the value of the characteristic can be accessed.

Implementations

impl<T: Debug + Default + Clone + Serialize + Send + Sync> Characteristic<T> where
    T: Deserialize<'de>, 

pub fn get_id(&self) -> u64

Returns the ID of a Characteristic.

pub fn get_type(&self) -> HapType

Returns the HapType of a Characteristic.

pub fn get_format(&self) -> Format

Returns the Format of a Characteristic.

pub fn get_perms(&self) -> Vec<Perm>

Returns the Perms of a Characteristic.

pub fn set_description(&mut self, description: Option<String>)

Sets the description of a Characteristic.

pub fn get_event_notifications(&self) -> Option<bool>

Returns the event notifications value of a Characteristic.

pub fn set_event_notifications(&mut self, event_notifications: Option<bool>)

Sets the event notifications value of a Characteristic.

pub async fn get_value<'_>(&'_ mut self) -> Result<T>

Returns the value of a Characteristic.

pub async fn set_value<'_>(&'_ mut self, val: T) -> Result<()>

Sets the value of a Characteristic.

pub fn get_unit(&self) -> Option<Unit>

Returns the Unit of a Characteristic.

pub fn get_max_value(&self) -> Option<T>

Returns the maximum value of a Characteristic.

pub fn set_max_value(&mut self, val: Option<T>)

Sets the maximum value of a Characteristic.

pub fn get_min_value(&self) -> Option<T>

Returns the minimum value of a Characteristic.

pub fn set_min_value(&mut self, val: Option<T>)

Sets the minimum value of a Characteristic.

pub fn get_step_value(&self) -> Option<T>

Returns the step value of a Characteristic.

pub fn set_step_value(&mut self, val: Option<T>)

Returns the step value of a Characteristic.

pub fn get_max_len(&self) -> Option<u16>

Returns the maximum length of a Characteristic.

pub fn on_read(&mut self, f: Option<impl OnReadFn<T>>)

Sets a callback function on a characteristic that is called every time a controller attempts to read its value. Returning a Some(T) from this function changes the value of the Characteristic before the Controller reads it so the Controller reads the new value.

pub fn on_update(&mut self, f: Option<impl OnUpdateFn<T>>)

Sets a callback function on a characteristic that is called every time a controller attempts to update its value. The first argument is a reference to the current value of the characteristic and the second argument is a reference to the value the controller attempts to change the characteristic's to.

pub fn on_read_async(&mut self, f: Option<impl OnReadFuture<T>>)

Sets an async callback function on a characteristic that is driven to completion by the async runtime driving the HAP server every time a controller attempts to read its value. Returning a Some(T) from this function changes the value of the characteristic before the controller reads it so the controller reads the new value.

pub fn on_update_async(&mut self, f: Option<impl OnUpdateFuture<T>>)

Sets an async callback function on a characteristic that is driven to completion by the async runtime driving the HAP server every time a controller attempts to update its value. The first argument is a reference to the current value of the characteristic and the second argument is a reference to the value the controller attempts to change the characteristic's to.

Trait Implementations

impl<T: Debug + Default + Clone + Serialize + Send + Sync> Debug for Characteristic<T>

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

Formats the value using the given formatter.

impl<T: Default + Debug + Clone + Serialize + Send + Sync> Default for Characteristic<T>

pub fn default() -> Characteristic<T>

Returns the "default value" for a type.

impl<T: Debug + Default + Clone + Serialize + Send + Sync> Serialize for Characteristic<T>

pub fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.