Struct Provider 

pub struct Provider {
    pub fab_idx: NonZero<u8>,
    pub node_id: u64,
    pub endpoint: u16,
}

One OTA Provider, scoped to the fabric that registered (or announced) it.

Fields

fab_idx: NonZero<u8>

The fabric this provider belongs to.

node_id: u64

The provider node’s id.

endpoint: u16

The endpoint on the provider node hosting the OTA Provider cluster.

Implementations

impl Provider

pub async fn query<C, F, R>( &self, matter: &Matter<'_>, crypto: C, protocols: &[DownloadProtocolEnum], current_version: Option<u32>, requestor_can_consent: bool, f: F, ) -> Result<R, Error>

where C: Crypto, F: FnOnce(&QueryImageResponse<'_>) -> Result<R, Error>,

Ask this provider whether a software image newer than current_version (defaulting to this device’s sw_ver from BasicInfoConfig when None) is available, advertising the given download protocols.

The request’s VendorID, ProductID, SoftwareVersion and HardwareVersion are taken from the node’s BasicInfoConfig, and Location from the configured Basic Information settings - the spec requires each to equal the corresponding Basic Information cluster attribute. requestor_can_consent declares whether this requestor can obtain user consent on its own (via built-in UI); pass true only if so, as it lets the provider delegate consent (see OtaImagesRegistry).

Opens a CASE exchange to the provider, sends QueryImage, and invokes f with the QueryImageResponse before the exchange is released - so f reads image_uri/software_version/update_token straight off the RX buffer without copying them onto the stack. f’s return value is returned.

query does not interpret the response (it checks neither status nor the returned version); that is left to f. On a bdx:// image_uri, use parse_bdx_url + Exchange::download to fetch.

pub async fn apply_update<C>( &self, matter: &Matter<'_>, crypto: C, update_token: &[u8], new_version: u32, ) -> Result<OtaApplyOutcome, Error>

where C: Crypto,

Ask this provider how to apply the already-downloaded image identified by update_token (the UpdateToken from the provider’s QueryImageResponse), which upgrades to new_version.

Opens a CASE exchange and sends ApplyUpdateRequest. The returned OtaApplyOutcome is the provider’s decision: Proceed (apply, after its delay), Await (wait the delay and call this again), or Discontinue (discard the image).

pub async fn notify_applied<C>( &self, matter: &Matter<'_>, crypto: C, update_token: &[u8], software_version: u32, ) -> Result<(), Error>

where C: Crypto,

Tell this provider that the image identified by update_token has been applied, now running software_version. Opens a CASE exchange and sends NotifyUpdateApplied; there is no response payload.

Trait Implementations

impl Clone for Provider

fn clone(&self) -> Provider

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Provider

impl Debug for Provider

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

Formats the value using the given formatter.

impl Eq for Provider

impl<'__from_tlv> FromTLV<'__from_tlv> for Provider

fn from_tlv(element: &TLVElement<'__from_tlv>) -> Result<Provider, Error>

Deserialize the type from a TLV-encoded element.

fn init_from_tlv(element: TLVElement<'__from_tlv>) -> impl Init<Provider, Error>

Generate an in-place initializer for the type that initializes the type from a TLV-encoded element.

fn nullable_from_tlv(element: &TLVElement<'a>) -> Result<Self, Error>

Deserialize the type from a TLV-encoded element.

fn init_nullable_from_tlv(element: TLVElement<'a>) -> impl Init<Self, Error>

Generate an in-place initializer for the type that initializes the type from a TLV-encoded element.

impl PartialEq for Provider

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Provider

impl ToTLV for Provider

fn to_tlv<W>(&self, tag: &TLVTag, tw: W) -> Result<(), Error>

where W: TLVWrite,

Serialize the type to a TLV-encoded stream.

fn tlv_iter(&self, tag: TLVTag) -> impl Iterator<Item = Result<TLV<'_>, Error>>

Serialize the type as an iterator of TLV instances by potentially borrowing data from the type.

fn nullable_to_tlv<W>(&self, tag: &TLVTag, tw: W) -> Result<(), Error>

where W: TLVWrite,

Serialize the type to a TLV-encoded stream.

fn nullable_tlv_iter( &self, tag: TLVTag, ) -> impl Iterator<Item = Result<TLV<'_>, Error>>

Serialize the type as an iterator of TLV instances by potentially borrowing data from the type.

impl<'__from_tlv> TryFrom<&TLVElement<'__from_tlv>> for Provider

type Error = Error

The type returned in the event of a conversion error.

fn try_from( element: &TLVElement<'__from_tlv>, ) -> Result<Provider, <Provider as TryFrom<&TLVElement<'__from_tlv>>>::Error>

Performs the conversion.