Struct NetCtlState 

pub struct NetCtlState {
    pub network_id: Vec<u8, rs_matter::::dm::networks::wireless::OwnedWirelessNetworkId::{constant#0}>,
    pub networking_status: Option<NetworkCommissioningStatusEnum>,
    pub connect_error_value: Option<i32>,
}

A type holding the status of the last connect or scan operation for the NetCtlWithStatus NetCtl + NetCtlStatus implementation.

Fields

network_id: Vec<u8, rs_matter::::dm::networks::wireless::OwnedWirelessNetworkId::{constant#0}>

The network ID used in the last scan or connect operation

networking_status: Option<NetworkCommissioningStatusEnum>

The status of the last scan or connect operation

connect_error_value: Option<i32>

The error code of the last scan or connect operation. If the last operation was scan, this value is None.

Implementations

impl NetCtlState

pub const fn new() -> NetCtlState

Create a new, empty instance of NetCtlState.

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

Return an in-place initializer for a new, empty NetCtlState.

pub const fn new_with_mutex() -> Mutex<RefCell<NetCtlState>>

Create a new, empty instance of NetCtlState wrapped in a mutex.

pub fn init_with_mutex() -> impl Init<Mutex<RefCell<NetCtlState>>>

Return an in-place initializer for a new, empty NetCtlState wrapped in a mutex.

pub fn is_prov_ready(&self) -> bool

Return true if the network ID is set and the last operation was successful.

pub fn update<R>( &mut self, network_id: Option<&[u8]>, result: Result<R, NetCtlError>, ) -> Result<R, NetCtlError>

Update the state with the provided network ID and result of the last operation.

Return the result of the last operation.

pub fn update_with_mutex<R>( state: &Mutex<RefCell<NetCtlState>>, network_id: Option<&[u8]>, result: Result<R, NetCtlError>, ) -> Result<R, NetCtlError>

Update the state with the provided network ID and result of the last operation.

Return the result of the last operation.

pub async fn wait_prov_ready(state: &Mutex<RefCell<NetCtlState>>, _btp: &Btp)

A utility to wait for provisioning over BTP to be ready. Provisioning over BTP is considered complete when there is no longer an active connection and the network ID is set (i.e. method NetCtl::connect was called successfully).

This method is only useful for non-concurrent commisioning using wireless networks and BLE, and is likely to be used together with NoopWirelessNetCtl.

Trait Implementations

impl Default for NetCtlState

fn default() -> NetCtlState

Returns the “default value” for a type.