pub struct ThreadCapabilities(/* private fields */);Expand description
ThreadCapabilitiesBitmap (§11.9.5.2).
“The valid combinations of capabilities are restricted and dependent on Thread version”, so nothing here validates a combination — the Thread stack is the authority.
Implementations§
Source§impl ThreadCapabilities
impl ThreadCapabilities
Sourcepub const IS_BORDER_ROUTER_CAPABLE: Self
pub const IS_BORDER_ROUTER_CAPABLE: Self
Bit 0 — Thread Border Router functionality is present.
Sourcepub const IS_ROUTER_CAPABLE: Self
pub const IS_ROUTER_CAPABLE: Self
Bit 1 — router or REED mode is supported.
Sourcepub const IS_SLEEPY_END_DEVICE_CAPABLE: Self
pub const IS_SLEEPY_END_DEVICE_CAPABLE: Self
Bit 2 — sleepy end-device mode is supported.
Sourcepub const IS_FULL_THREAD_DEVICE: Self
pub const IS_FULL_THREAD_DEVICE: Self
Bit 3 — a full Thread device, as opposed to a Minimal Thread Device.
Sourcepub const IS_SYNCHRONIZED_SLEEPY_END_DEVICE_CAPABLE: Self
pub const IS_SYNCHRONIZED_SLEEPY_END_DEVICE_CAPABLE: Self
Bit 4 — synchronized sleepy end-device mode is supported.
Source§impl ThreadCapabilities
impl ThreadCapabilities
Sourcepub const fn bits(&self) -> u16
pub const fn bits(&self) -> u16
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> Option<Self>
Convert from a bits value.
This method will return None if any unknown bits are set.
Sourcepub const fn from_bits_truncate(bits: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u16) -> Self
pub const fn from_bits_retain(bits: u16) -> Self
Convert from a bits value exactly.
Sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
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.
Sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in other are also set in self.
Sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in other are also set in self.
Sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
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.
Sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in self and other.
Sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert when value is true or remove when value is false.
Sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&) of the bits in self and other.
Sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|) of the bits in self and other.
Sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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.
Sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^) of the bits in self and other.
Sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!) of the bits in self, truncating the result.
Source§impl ThreadCapabilities
impl ThreadCapabilities
Sourcepub const fn iter(&self) -> Iter<ThreadCapabilities> ⓘ
pub const fn iter(&self) -> Iter<ThreadCapabilities> ⓘ
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.
Sourcepub const fn iter_names(&self) -> IterNames<ThreadCapabilities> ⓘ
pub const fn iter_names(&self) -> IterNames<ThreadCapabilities> ⓘ
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§
Source§impl Binary for ThreadCapabilities
impl Binary for ThreadCapabilities
Source§impl BitAnd for ThreadCapabilities
impl BitAnd for ThreadCapabilities
Source§impl BitAndAssign for ThreadCapabilities
impl BitAndAssign for ThreadCapabilities
Source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&) of the bits in self and other.
Source§impl BitOr for ThreadCapabilities
impl BitOr for ThreadCapabilities
Source§fn bitor(self, other: ThreadCapabilities) -> Self
fn bitor(self, other: ThreadCapabilities) -> Self
The bitwise or (|) of the bits in self and other.
Source§type Output = ThreadCapabilities
type Output = ThreadCapabilities
| operator.Source§impl BitOrAssign for ThreadCapabilities
impl BitOrAssign for ThreadCapabilities
Source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|) of the bits in self and other.
Source§impl BitXor for ThreadCapabilities
impl BitXor for ThreadCapabilities
Source§impl BitXorAssign for ThreadCapabilities
impl BitXorAssign for ThreadCapabilities
Source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^) of the bits in self and other.
Source§impl Clone for ThreadCapabilities
impl Clone for ThreadCapabilities
impl Copy for ThreadCapabilities
Source§impl Debug for ThreadCapabilities
impl Debug for ThreadCapabilities
Source§impl Default for ThreadCapabilities
impl Default for ThreadCapabilities
impl Eq for ThreadCapabilities
Source§impl Extend<ThreadCapabilities> for ThreadCapabilities
impl Extend<ThreadCapabilities> for ThreadCapabilities
Source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|) of the bits in each flags value.
Source§fn extend_one(&mut self, item: T)
fn extend_one(&mut self, item: T)
extend_one)Source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one)Source§impl Flags for ThreadCapabilities
impl Flags for ThreadCapabilities
Source§const FLAGS: &'static [Flag<ThreadCapabilities>]
const FLAGS: &'static [Flag<ThreadCapabilities>]
Source§fn from_bits_retain(bits: u16) -> ThreadCapabilities
fn from_bits_retain(bits: u16) -> ThreadCapabilities
Source§fn all_named() -> ThreadCapabilities
fn all_named() -> ThreadCapabilities
Source§fn known_bits(&self) -> Self::Bits
fn known_bits(&self) -> Self::Bits
Source§fn unknown_bits(&self) -> Self::Bits
fn unknown_bits(&self) -> Self::Bits
Source§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true if any unknown bits are set.Source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
Source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
Source§fn iter_names(&self) -> IterNames<Self> ⓘ
fn iter_names(&self) -> IterNames<Self> ⓘ
Source§fn iter_defined_names() -> IterDefinedNames<Self> ⓘ
fn iter_defined_names() -> IterDefinedNames<Self> ⓘ
Self::FLAGS.Source§fn iter_equal_names(&self) -> IterEqualNames<Self> ⓘ
fn iter_equal_names(&self) -> IterEqualNames<Self> ⓘ
Source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
other are also set in self.Source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
other are also set in self.Source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|) of the bits in self and other.Source§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^) of the bits in self and other.Source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&) of the bits in self and other.Source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
Source§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^) of the bits in self and other.Source§fn complement(self) -> Self
fn complement(self) -> Self
!) of the bits in self, truncating the result.Source§impl FromIterator<ThreadCapabilities> for ThreadCapabilities
impl FromIterator<ThreadCapabilities> for ThreadCapabilities
Source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|) of the bits in each flags value.
Source§impl Hash for ThreadCapabilities
impl Hash for ThreadCapabilities
Source§impl IntoIterator for ThreadCapabilities
impl IntoIterator for ThreadCapabilities
Source§impl LowerHex for ThreadCapabilities
impl LowerHex for ThreadCapabilities
Source§impl Not for ThreadCapabilities
impl Not for ThreadCapabilities
Source§impl Octal for ThreadCapabilities
impl Octal for ThreadCapabilities
Source§impl PartialEq for ThreadCapabilities
impl PartialEq for ThreadCapabilities
Source§impl PublicFlags for ThreadCapabilities
impl PublicFlags for ThreadCapabilities
impl StructuralPartialEq for ThreadCapabilities
Source§impl Sub for ThreadCapabilities
impl Sub for ThreadCapabilities
Source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
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.
Source§type Output = ThreadCapabilities
type Output = ThreadCapabilities
- operator.Source§impl SubAssign for ThreadCapabilities
impl SubAssign for ThreadCapabilities
Source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
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.