Struct PairingHintFlags 

pub struct PairingHintFlags(/* private fields */);

Implementations

impl PairingHintFlags

pub const POWER_CYCLE: PairingHintFlags

Power Cycle False The Device will automatically enter Commissioning Mode upon power cycle (unplug/replug, remove/re-insert batteries). This bit SHALL be set to 1 for devices using Standard Commissioning Flow, and set to 0 otherwise.

pub const DEV_MANUFACTURER_URL: PairingHintFlags

This SHALL be set to 1 for devices requiring Custom Commissioning Flow before they can be available for Commissioning by any Commissioner. For such a flow, the user SHOULD be sent to the URL specified in the CommissioningCustomFlowUrl of the DeviceModel schema entry indexed by the Vendor ID and Product ID (e.g., as found in the announcement) in the Distributed Compliance Ledger.

pub const ADMINISTRATOR: PairingHintFlags

The Device has been commissioned. Any Administrator that commissioned the device provides a user interface that may be used to put the device into Commissioning Mode.

pub const SETTINGS_MENU: PairingHintFlags

The settings menu on the Device provides instructions to put it into Commissioning Mode.

pub const CUSTOM_INSTRUCTION: PairingHintFlags

The PI key/value pair describes a custom way to put the Device into Commissioning Mode. This Custom Instruction option is NOT recommended for use by a Device that does not have knowledge of the user’s language preference.

pub const DEVICE_MANUAL: PairingHintFlags

The Device Manual provides special instructions to put the Device into Commissioning Mode (see “UserManualUrl” in the Core Spec). This is a catchall option to capture user interactions that are not codified by other options in this flags type.

pub const PRESS_RESET_BUTTON: PairingHintFlags

The Device will enter Commissioning Mode when reset button is pressed.

pub const PRESS_RESET_BUTTON_WITH_POWER: PairingHintFlags

The Device will enter Commissioning Mode when reset button is pressed when applying power to it.

pub const PRESS_RESET_BUTTON_FOR_N_SECONDS: PairingHintFlags

The Device will enter Commissioning Mode when reset button is pressed for N seconds. The exact value of N SHALL be made available via PI key.

pub const PRESS_RESET_BUTTON_UNTIL_LIGHT_BLINKS: PairingHintFlags

The Device will enter Commissioning Mode when reset button is pressed until associated light blinks. Information on color of light MAY be made available via PI key.

pub const PRESS_RESET_BUTTON_FOR_N_SECONDS_WITH_POWER: PairingHintFlags

The Device will enter Commissioning Mode when reset button is pressed for N seconds when applying power to it. The exact value of N SHALL be made available via PI key.

pub const PRESS_RESET_BUTTON_UNTIL_LIGHT_BLINKS_WITH_POWER: PairingHintFlags

The Device will enter Commissioning Mode when reset button is pressed until associated light blinks when applying power to the Device. Information on color of light MAY be made available via PI key.

pub const PRESS_RESET_BUTTON_N_TIMES: PairingHintFlags

The Device will enter Commissioning Mode when reset button is pressed N times with maximum 1 second between each press. The exact value of N SHALL be made available via PI key.

pub const PRESS_SETUP_BUTTON: PairingHintFlags

The Device will enter Commissioning Mode when setup button is pressed.

pub const PRESS_SETUP_BUTTON_WITH_POWER: PairingHintFlags

The Device will enter Commissioning Mode when setup button is pressed when applying power to it.

pub const PRESS_SETUP_BUTTON_FOR_N_SECONDS: PairingHintFlags

The Device will enter Commissioning Mode when setup button is pressed for N seconds. The exact value of N SHALL be made available via PI key.

pub const PRESS_SETUP_BUTTON_UNTIL_LIGHT_BLINKS: PairingHintFlags

The Device will enter Commissioning Mode when setup button is pressed until associated light blinks. Information on color of light MAY be made available via PI key.

pub const PRESS_SETUP_BUTTON_FOR_N_SECONDS_WITH_POWER: PairingHintFlags

The Device will enter Commissioning Mode when setup button is pressed for N seconds when applying power to it. The exact value of N SHALL be made available via PI key.

pub const PRESS_SETUP_BUTTON_UNTIL_LIGHT_BLINKS_WITH_POWER: PairingHintFlags

The Device will enter Commissioning Mode when setup button is pressed until associated light blinks when applying power to the Device. Information on color of light MAY be made available via PI key.

pub const PRESS_SETUP_BUTTON_N_TIMES: PairingHintFlags

The Device will enter Commissioning Mode when setup button is pressed N times with maximum 1 second between each press. The exact value of N SHALL be made available via PI key.

impl PairingHintFlags

pub const fn empty() -> PairingHintFlags

Get a flags value with all bits unset.

pub const fn all() -> PairingHintFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<PairingHintFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> PairingHintFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> PairingHintFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<PairingHintFlags>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: PairingHintFlags) -> bool

Whether any set bits in other are also set in self.

pub const fn contains(&self, other: PairingHintFlags) -> bool

Whether all set bits in other are also set in self.

pub fn insert(&mut self, other: PairingHintFlags)

The bitwise or (|) of the bits in self and other.

pub fn remove(&mut self, other: PairingHintFlags)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: PairingHintFlags)

The bitwise exclusive-or (^) of the bits in self and other.

pub fn set(&mut self, other: PairingHintFlags, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: PairingHintFlags) -> PairingHintFlags

The bitwise and (&) of the bits in self and other.

pub const fn union(self, other: PairingHintFlags) -> PairingHintFlags

The bitwise or (|) of the bits in self and other.

pub const fn difference(self, other: PairingHintFlags) -> PairingHintFlags

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference( self, other: PairingHintFlags, ) -> PairingHintFlags

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> PairingHintFlags

The bitwise negation (!) of the bits in self, truncating the result.

impl PairingHintFlags

pub const fn iter(&self) -> Iter<PairingHintFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<PairingHintFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for PairingHintFlags

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

Formats the value using the given formatter.

impl BitAnd for PairingHintFlags

fn bitand(self, other: PairingHintFlags) -> PairingHintFlags

The bitwise and (&) of the bits in self and other.

type Output = PairingHintFlags

The resulting type after applying the & operator.

impl BitAndAssign for PairingHintFlags

fn bitand_assign(&mut self, other: PairingHintFlags)

The bitwise and (&) of the bits in self and other.

impl BitOr for PairingHintFlags

fn bitor(self, other: PairingHintFlags) -> PairingHintFlags

The bitwise or (|) of the bits in self and other.

type Output = PairingHintFlags

The resulting type after applying the | operator.

impl BitOrAssign for PairingHintFlags

fn bitor_assign(&mut self, other: PairingHintFlags)

The bitwise or (|) of the bits in self and other.

impl BitXor for PairingHintFlags

fn bitxor(self, other: PairingHintFlags) -> PairingHintFlags

The bitwise exclusive-or (^) of the bits in self and other.

type Output = PairingHintFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for PairingHintFlags

fn bitxor_assign(&mut self, other: PairingHintFlags)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for PairingHintFlags

fn clone(&self) -> PairingHintFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PairingHintFlags

impl Debug for PairingHintFlags

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

Formats the value using the given formatter.

impl Default for PairingHintFlags

fn default() -> PairingHintFlags

Returns the “default value” for a type.

impl Eq for PairingHintFlags

impl Extend<PairingHintFlags> for PairingHintFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = PairingHintFlags>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for PairingHintFlags

const FLAGS: &'static [Flag<PairingHintFlags>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> PairingHintFlags

Convert from a bits value exactly.

fn all_named() -> PairingHintFlags

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in other are also set in self.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<PairingHintFlags> for PairingHintFlags

fn from_iter<T>(iterator: T) -> PairingHintFlags

where T: IntoIterator<Item = PairingHintFlags>,

The bitwise or (|) of the bits in each flags value.

impl Hash for PairingHintFlags

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

where __H: Hasher,

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 IntoIterator for PairingHintFlags

type Item = PairingHintFlags

The type of the elements being iterated over.

type IntoIter = Iter<PairingHintFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <PairingHintFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for PairingHintFlags

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

Formats the value using the given formatter.

impl Not for PairingHintFlags

fn not(self) -> PairingHintFlags

The bitwise negation (!) of the bits in self, truncating the result.

type Output = PairingHintFlags

The resulting type after applying the ! operator.

impl Octal for PairingHintFlags

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

Formats the value using the given formatter.

impl PartialEq for PairingHintFlags

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PairingHintFlags

impl Sub for PairingHintFlags

fn sub(self, other: PairingHintFlags) -> PairingHintFlags

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = PairingHintFlags

The resulting type after applying the - operator.

impl SubAssign for PairingHintFlags

fn sub_assign(&mut self, other: PairingHintFlags)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for PairingHintFlags

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

Formats the value using the given formatter.