Skip to main content

InteractionModelState

Struct InteractionModelState 

Source
pub struct InteractionModelState<N, const NS: usize = rs_matter::::im::InteractionModelState::{constant#0}, const NE: usize = rs_matter::::im::InteractionModelState::{constant#1}> { /* private fields */ }
Expand description

An ExchangeHandler implementation capable of handling responder exchanges for the Interaction Model protocol. The mutable, owned-together state a InteractionModel operates on: the subscriptions table, the events queue and the network store.

Allocating these as a single value (rather than three separate locals wired up by hand at every call site) is the whole point: construct one InteractionModelState, then hand a reference to it to InteractionModel::new. Each of the three pieces keeps its own lock internally (the proven multi-lock model); folding them behind a single mutex is a possible later refinement.

N is the (raw) Networks implementation — e.g. EthNetwork or WirelessNetworks; it is wrapped internally in a SharedNetworks so the data model and (later) the wireless manager can share it. NS/NE bound the subscription table and the event-buffer size and default to DEFAULT_MAX_SUBSCRIPTIONS / DEFAULT_MAX_EVENTS_BUF_SIZE.

Implementations§

Source§

impl<N, const NS: usize, const NE: usize> InteractionModelState<N, NS, NE>

Source

pub const fn new(networks: N) -> InteractionModelState<N, NS, NE>

Create a new state instance backed by the given (raw) Networks store.

Source

pub fn init( networks: impl Init<N>, ) -> impl Init<InteractionModelState<N, NS, NE>>

Return an in-place initializer for the state (for large NE, to avoid a big temporary on the stack).

Source

pub fn suppress_start_up_event(&self)

Suppress the BasicInformation::StartUp event that InteractionModel::run would otherwise emit when it first starts.

Call before run when starting the stack does not correspond to a device boot - e.g. a warm restart of the Matter stack within a running process, or a test fixture that needs a deterministic events queue.

Source

pub const fn subscriptions(&self) -> &Subscriptions<NS>

The subscriptions table.

Source

pub const fn events(&self) -> &Events<NE>

The events queue.

Source

pub const fn networks(&self) -> &SharedNetworks<N>

The network store (wrapped for shared, change-notifying access).

Auto Trait Implementations§

§

impl<N, const NS: usize = rs_matter::::im::InteractionModelState::{constant#0}, const NE: usize = rs_matter::::im::InteractionModelState::{constant#1}> !Freeze for InteractionModelState<N, NS, NE>

§

impl<N, const NS: usize = rs_matter::::im::InteractionModelState::{constant#0}, const NE: usize = rs_matter::::im::InteractionModelState::{constant#1}> !RefUnwindSafe for InteractionModelState<N, NS, NE>

§

impl<N, const NS: usize = rs_matter::::im::InteractionModelState::{constant#0}, const NE: usize = rs_matter::::im::InteractionModelState::{constant#1}> !Sync for InteractionModelState<N, NS, NE>

§

impl<N, const NS: usize, const NE: usize> Send for InteractionModelState<N, NS, NE>
where N: Send,

§

impl<N, const NS: usize, const NE: usize> Unpin for InteractionModelState<N, NS, NE>
where N: Unpin,

§

impl<N, const NS: usize, const NE: usize> UnsafeUnpin for InteractionModelState<N, NS, NE>
where N: UnsafeUnpin,

§

impl<N, const NS: usize, const NE: usize> UnwindSafe for InteractionModelState<N, NS, NE>
where N: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, E> Init<T, E> for T

Source§

unsafe fn __init(self, slot: *mut T) -> Result<(), E>

Initializes slot. Read more
Source§

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, I> IntoFallibleInit<T> for I
where I: Init<T>,

Source§

fn into_fallible<E>(self) -> impl Init<T, E>

Convert the infallible initializer to a fallible one.
Source§

impl<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

Source§

type Error = <Target as OctetsFrom<Source>>::Error

Source§

fn try_octets_into( self, ) -> Result<Target, <Source as OctetsInto<Target>>::Error>

Performs the conversion.
Source§

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

Performs an infallible conversion.
Source§

impl<T, E> PinInit<T, E> for T

Source§

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), E>

Initializes slot. Read more
Source§

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V