Enum ConnectivityState

pub enum ConnectivityState {
    Inactive,
    Ready,
    Offline,
    Attaching,
    Attached,
    Isolated,
    Commissioning,
    // some variants omitted
}

LoWPAN Connectivity State

This enum describes the level of connectivity being provided by a device.

Variants

Inactive

Inactive state.

In this state the device is unprovisioned and administratively disabled (inactive).

This state can always be explicitly entered by calling Leave followed by SetActive(false).

Ready

Ready state.

In this state the device is provisioned for a network, but is administratively disabled (inactive).

This state can be directly entered with the following actions based on the current connectivity state:

• INACTIVE: by calling ProvisionNetwork(...).
• ATTACHING, ATTACHED, ISOLATED, COMMISSIONING: by calling SetActive(false).

Offline

Offline state.

In this state the device is administratively enabled (active) but is not provisioned and thus has no network to attach to.

This state can be directly entered with the following actions based on the current connectivity state:

• INACTIVE: by calling SetActive(true).
• ATTACHING, ATTACHED, ISOLATED, COMMISSIONING: by calling Leave().

Attaching

Attaching state.

In this state the device is administratively enabled (active) and either provisioned for a network or shortly about to become provisioned for a network.

The interface enters this state when it starts the process of trying to find other nodes so that it can attach to any pre-existing network fragment, or when it is in the process of calculating the optimal values for unspecified parameters when forming a new network.

This state can be directly entered with the following actions based on the current connectivity state:

• READY: by calling SetActive(true)
• OFFLINE, ATTACHING, ATTACHED, ISOLATED, COMMISSIONING: by calling ProvisionNetwork(...), FormNetwork(...), or JoinNetwork(...)

Attached

Attached state.

In this state the device is both administratively enabled (active) and provisioned for a network. The device is an active participant on the network and can communicate with peers.

This state usually implies that peers are available, but that may not actually be the case due to current network conditions or privacy-protecting measures.

This state cannot generally be entered directly, rather the device will enter this state automatically from the ATTACHING or ISOLATED states once connectivity has been (re)established.

Isolated

Isolated state.

In this state the device is both administratively enabled (active) and provisioned for a network. However, the device has no connectivity because there are no peers in range on the provisioned network.

Once peer devices on the same network come into range the connectivity state will eventually switch back to ATTACHED, indicating restored connectivity with at least one peer.

This state cannot generally be entered directly, rather the device may enter this state automatically from the ATTACHING or ATTACHED states.

Commissioning

Commissioning state.

Currently unused, but will later be used to support in-band commissioning. It is usually appropriate to consider this as a synonym for the ATTACHING state except that the device remains unprovisioned.

Implementations

impl ConnectivityState

pub fn from_primitive(prim: i32) -> Option<Self>

pub fn from_primitive_allow_unknown(prim: i32) -> Self

pub fn unknown() -> Self

pub const fn into_primitive(self) -> i32

pub fn is_unknown(&self) -> bool

Trait Implementations

impl Clone for ConnectivityState

fn clone(&self) -> ConnectivityState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectivityState

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<ConnectivityState, D> for ConnectivityState

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl<D: ResourceDialect> Encode<ConnectivityState, D> for ConnectivityState

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl Hash for ConnectivityState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ConnectivityState

fn cmp(&self, other: &ConnectivityState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ConnectivityState

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ConnectivityState

fn partial_cmp(&self, other: &ConnectivityState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TypeMarker for ConnectivityState

type Owned = ConnectivityState

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for ConnectivityState

type Borrowed<'a> = ConnectivityState

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Copy for ConnectivityState

impl Eq for ConnectivityState

impl StructuralPartialEq for ConnectivityState