Struct hap::characteristic::model::ModelCharacteristic

pub struct ModelCharacteristic(_);

Model Characteristic.

Implementations

impl ModelCharacteristic

pub fn new(id: u64, accessory_id: u64) -> Self

Creates a new Model Characteristic.

Trait Implementations

impl AsyncCharacteristicCallbacks<String> for ModelCharacteristic

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

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<String>>)

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.

impl CharacteristicCallbacks<String> for ModelCharacteristic

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

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<String>>)

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.

impl Debug for ModelCharacteristic

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

Formats the value using the given formatter.

impl Default for ModelCharacteristic

pub fn default() -> ModelCharacteristic

Returns the "default value" for a type.

impl HapCharacteristic for ModelCharacteristic

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 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 fn get_value<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the value of a Characteristic.

pub fn set_value<'life0, 'async_trait>(
    &'life0 mut self,
    value: Value
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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<Value>

Returns the maximum value of a Characteristic.

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

Returns the minimum value of a Characteristic.

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

Returns the step value of a Characteristic.

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

Returns the maximum length of a Characteristic.

impl HapCharacteristicSetup for ModelCharacteristic

pub fn set_event_emitter(
    &mut self,
    event_emitter: Option<Arc<Mutex<EventEmitter>>>
)

Sets a hap::event::pointer::EventEmitter on the characteristic.

impl Serialize for ModelCharacteristic

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.