Struct hap::service::security_system::SecuritySystemService

pub struct SecuritySystemService {
    pub security_system_current_state: SecuritySystemCurrentStateCharacteristic,
    pub security_system_target_state: SecuritySystemTargetStateCharacteristic,
    pub status_fault: Option<StatusFaultCharacteristic>,
    pub status_tampered: Option<StatusTamperedCharacteristic>,
    pub security_system_alarm_type: Option<SecuritySystemAlarmTypeCharacteristic>,
    pub name: Option<NameCharacteristic>,
    // some fields omitted
}

Security System Service.

Fields

security_system_current_state: SecuritySystemCurrentStateCharacteristic

Security System Current State Characteristic (required).

security_system_target_state: SecuritySystemTargetStateCharacteristic

Security System Target State Characteristic (required).

status_fault: Option<StatusFaultCharacteristic>

Status Fault Characteristic (optional).

status_tampered: Option<StatusTamperedCharacteristic>

Status Tampered Characteristic (optional).

security_system_alarm_type: Option<SecuritySystemAlarmTypeCharacteristic>

Security System Alarm Type Characteristic (optional).

name: Option<NameCharacteristic>

Name Characteristic (optional).

Implementations

impl SecuritySystemService

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

Creates a new Security System Service.

Trait Implementations

impl Debug for SecuritySystemService

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

Formats the value using the given formatter.

impl Default for SecuritySystemService

pub fn default() -> SecuritySystemService

Returns the "default value" for a type.

impl HapService for SecuritySystemService

pub fn get_id(&self) -> u64

Returns the ID of a Service.

pub fn get_type(&self) -> HapType

Returns the HapType of a Service.

pub fn get_hidden(&self) -> bool

Returns the hidden value of a Service.

pub fn set_hidden(&mut self, hidden: bool)

Sets the hidden value of a Service.

pub fn get_primary(&self) -> bool

Returns the primary value of a Service.

pub fn set_primary(&mut self, primary: bool)

Sets the primary value of a Service.

pub fn get_characteristic(
    &self,
    hap_type: HapType
) -> Option<&dyn HapCharacteristic>

Returns a reference to a specific Characteristic of the Service if it's present on it.

pub fn get_mut_characteristic(
    &mut self,
    hap_type: HapType
) -> Option<&mut dyn HapCharacteristic>

Returns a mutable reference to a specific Characteristic of the Service if it's present on it.

pub fn get_characteristics(&self) -> Vec<&dyn HapCharacteristic>

Returns references to the Characteristics of a Service.

pub fn get_mut_characteristics(&mut self) -> Vec<&mut dyn HapCharacteristic>

Returns mutable references to the Characteristics of a Service.

impl Serialize for SecuritySystemService

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

Serialize this value into the given Serde serializer.