Skip to main content

Providers

Struct Providers 

Source
pub struct Providers { /* private fields */ }
Expand description

The OTA Requestor’s provider registry: the persistent, fabric-scoped DefaultOTAProviders list (at most one entry per fabric) and a transient cache of providers learned via AnnounceOTAProvider.

Modeled on the Binding cluster’s registry: the default list is persisted as a single TLV blob under OTA_PROVIDERS_KEY; announced providers are never persisted. wait_changed signals the application when the set changes (an admin write or an announcement).

Implementations§

Source§

impl Providers

Source

pub const fn new() -> Providers

Create an empty registry. Prefer Self::init for a large MAX_FABRICS.

Source

pub fn init() -> impl Init<Providers>

An in-place initializer for an empty registry.

Source

pub fn load_persist<S>(&self, store: S, buf: &mut [u8]) -> Result<(), Error>
where S: KvBlobStore,

Re-hydrate the default provider list from store.

Called on startup via the LifecycleOp::Startup lifecycle operation delivered to the OtaRequestorHandler borrowing this registry.

Source

pub fn reset_persist<S>(&self, store: S, buf: &mut [u8]) -> Result<(), Error>
where S: KvBlobStore,

Reset the registry - both the persisted default provider list and the transient announced-provider cache - and remove the persisted blob from store (under OTA_PROVIDERS_KEY).

Called on factory reset via the LifecycleOp::FactoryReset lifecycle operation delivered to the OtaRequestorHandler borrowing this registry.

Source

pub fn remove_for_fabric(&self, fab_idx: NonZero<u8>) -> bool

Drop the default and announced providers belonging to fab_idx, returning whether anything was removed. Signals wait_changed when so.

Called on fabric removal via the LifecycleOp::FabricRemoval lifecycle operation delivered to the OtaRequestorHandler borrowing this registry. Idempotent.

Source

pub fn len(&self) -> usize

The number of configured default providers (across all fabrics).

Source

pub fn is_empty(&self) -> bool

Whether there are no configured default providers.

Source

pub fn get(&self, index: usize) -> Option<Provider>

The index-th default provider, cloned out so the registry lock is not held across the caller’s subsequent (likely async) work.

Source

pub fn announced_len(&self) -> usize

The number of cached announced providers.

Source

pub fn announced(&self, index: usize) -> Option<Provider>

The index-th announced provider, cloned out.

Source

pub fn clear_announced(&self)

Drop all cached announced providers (e.g. once the app has queried them).

Source

pub fn take_announced( &self, ) -> Vec<Provider, rs_matter::::dm::clusters::ota_req::{impl#2}::take_announced::{constant#0}>

Atomically remove and return all cached announced providers.

Prefer this to iterating announced and then calling clear_announced in an update loop: providers learned via AnnounceOTAProvider while the loop is busy processing this batch land in a fresh announced set (and re-arm wait_changed) instead of being discarded unprocessed by a trailing clear.

Source

pub async fn wait_changed(&self)

Wait until the provider set changes (a DefaultOTAProviders write or an AnnounceOTAProvider command).

Trait Implementations§

Source§

impl Default for Providers

Source§

fn default() -> Providers

Returns the “default value” for a type. 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<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