Skip to main content

SubscribeRequest

Struct SubscribeRequest 

Source
pub struct SubscribeRequest {
    pub keep_subscriptions: bool,
    pub min_interval_floor: u16,
    pub max_interval_ceiling: u16,
    pub paths: Vec<ReadPath>,
    pub event_paths: Vec<EventPath>,
    pub event_filters: Vec<EventFilter>,
}
Expand description

Parameters for a subscription request.

Encodes as a SubscribeRequestMessage (Matter §10.6.6): keepSubscriptions (ctx 0), minIntervalFloor (ctx 1), maxIntervalCeiling (ctx 2), attributeRequests array (ctx 3), isFabricFiltered (ctx 7), interactionModelRevision (ctx 0xFF).

Fields§

§keep_subscriptions: bool

Whether to keep existing subscriptions alive when this one is established. false is the typical controller-side value.

§min_interval_floor: u16

Minimum reporting interval floor in seconds.

§max_interval_ceiling: u16

Maximum reporting interval ceiling in seconds.

§paths: Vec<ReadPath>

Attribute paths to subscribe to. Each ReadPath field that is Some is emitted as a context-tagged member of the AttributePathIB list (endpoint=2, cluster=3, attribute=4); None fields are omitted (wildcard).

§event_paths: Vec<EventPath>

Event paths to subscribe to (EventRequests, context tag 4). Empty ⇒ the array is omitted.

§event_filters: Vec<EventFilter>

Event filters (EventFilters, context tag 5) — report only events with number >= event_min. Empty ⇒ the array is omitted.

Trait Implementations§

Source§

impl Clone for SubscribeRequest

Source§

fn clone(&self) -> SubscribeRequest

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
Source§

impl Debug for SubscribeRequest

Source§

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

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

impl PartialEq for SubscribeRequest

Source§

fn eq(&self, other: &SubscribeRequest) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SubscribeRequest

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, 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.