Skip to main content

HapBridge

Struct HapBridge 

Source
pub struct HapBridge {
    pub service_record: HapServiceRecord,
    /* private fields */
}
Expand description

HOMECORE-to-HAP accessory bridge state.

Call HapBridge::add_accessory to register entities and HapBridge::running_accessories to read back what is currently registered. Use start_server for the bounded TCP lifecycle.

Fields§

§service_record: HapServiceRecord

Implementations§

Source§

impl HapBridge

Source

pub fn new(service_record: HapServiceRecord) -> Self

Create a bridge with the given service record and a NullAdvertiser.

Source

pub fn with_advertiser( service_record: HapServiceRecord, advertiser: Arc<dyn MdnsAdvertiser>, ) -> Self

Create a bridge with a custom MdnsAdvertiser.

Source

pub fn add_accessory( &self, entity_id: &EntityId, state: &State, ) -> Result<(), HapError>

Register an entity as a HAP accessory.

The entity’s current mapping is computed from state; call update_accessory on each StateChanged event to keep it fresh.

Returns HapError::AlreadyRegistered if the entity is already registered. Call remove_accessory first to replace it.

Source

pub fn remove_accessory(&self, entity_id: &EntityId) -> Result<(), HapError>

Remove a registered accessory.

Returns HapError::EntityNotFound if the entity was not registered.

Source

pub fn update_accessory( &self, entity_id: &EntityId, state: &State, ) -> Result<(), HapError>

Refresh a registered accessory and notify event subscribers.

Source

pub fn subscribe_events(&self) -> Receiver<CharacteristicEvent>

Subscribe to bounded characteristic updates. Lagging receivers receive Tokio’s explicit Lagged error and must resynchronize from a snapshot.

Source

pub fn running_accessories(&self) -> Vec<ExposedAccessory>

Snapshot all currently registered accessories.

Source

pub fn len(&self) -> usize

Number of registered accessories.

Source

pub fn is_empty(&self) -> bool

Source

pub async fn start(&self) -> Result<(), HapError>

Start advertisement only.

This legacy lifecycle does not bind a TCP listener. New integrations should call start_server, which advertises only after binding.

Source

pub async fn stop(&self) -> Result<(), HapError>

Graceful shutdown — retracts mDNS advertisement.

Trait Implementations§

Source§

impl Clone for HapBridge

Source§

fn clone(&self) -> HapBridge

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

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more