pub struct WildcardPathFlags(/* private fields */);Expand description
WildcardPathFlags — which kinds of attribute a wildcard expansion skips
(§2.13.2).
A client that only wants a device’s own state can ask a wildcard not to expand into the global attributes every cluster carries, which is most of what a naive wildcard read returns.
Implementations§
Source§impl WildcardPathFlags
impl WildcardPathFlags
Sourcepub const SKIP_ROOT_NODE: Self
pub const SKIP_ROOT_NODE: Self
Bit 0 — “Skip the Root Node endpoint (endpoint 0) during wildcard expansion.”
Sourcepub const SKIP_GLOBAL_ATTRIBUTES: Self
pub const SKIP_GLOBAL_ATTRIBUTES: Self
Bit 1 — “Skip several large global attributes”: §8.2.1.6 names exactly three,
GeneratedCommandList, AcceptedCommandList and AttributeList.
Sourcepub const SKIP_ATTRIBUTE_LIST: Self
pub const SKIP_ATTRIBUTE_LIST: Self
Bit 2 — “Skip the AttributeList global attribute” (0xFFFB) alone.
Sourcepub const SKIP_COMMAND_LISTS: Self
pub const SKIP_COMMAND_LISTS: Self
Bit 4 — “Skip the AcceptedCommandList and GeneratedCommandList global attributes.”
Bit 4, not bit 3. §2.13.2’s table reserves bit 3 as DoNotUse, and reading the
list of names without the bit numbers beside them puts this and every flag after it
one place too low — which is what this crate did, silently, for as long as nothing
honoured them.
Sourcepub const SKIP_CUSTOM_ELEMENTS: Self
pub const SKIP_CUSTOM_ELEMENTS: Self
Bit 5 — “Skip any manufacturer-specific clusters or attributes.”
Sourcepub const SKIP_FIXED_ATTRIBUTES: Self
pub const SKIP_FIXED_ATTRIBUTES: Self
Bit 6 — “Skip any Fixed (F) quality attributes.”
Sourcepub const SKIP_CHANGES_OMITTED: Self
pub const SKIP_CHANGES_OMITTED: Self
Bit 7 — “Skip any Changes Omitted (C) quality attributes.”
Sourcepub const SKIP_DIAGNOSTICS_CLUSTERS: Self
pub const SKIP_DIAGNOSTICS_CLUSTERS: Self
Bit 8 — “Skip all clusters with the Diagnostics (K) quality.”
Decoded and round-tripped, and not applied during expansion: ClusterDescriptor
carries no Diagnostics quality to test, and inventing one from the cluster id would
be a guess about which clusters the specification means. A flag this node cannot
honour is one it does not act on; see [AttributePath::unsupported_flags].
Source§impl WildcardPathFlags
impl WildcardPathFlags
Sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> 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 WildcardPathFlags
impl WildcardPathFlags
Sourcepub const fn iter(&self) -> Iter<WildcardPathFlags> ⓘ
pub const fn iter(&self) -> Iter<WildcardPathFlags> ⓘ
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<WildcardPathFlags> ⓘ
pub const fn iter_names(&self) -> IterNames<WildcardPathFlags> ⓘ
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 WildcardPathFlags
impl Binary for WildcardPathFlags
Source§impl BitAnd for WildcardPathFlags
impl BitAnd for WildcardPathFlags
Source§impl BitAndAssign for WildcardPathFlags
impl BitAndAssign for WildcardPathFlags
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 WildcardPathFlags
impl BitOr for WildcardPathFlags
Source§fn bitor(self, other: WildcardPathFlags) -> Self
fn bitor(self, other: WildcardPathFlags) -> Self
The bitwise or (|) of the bits in self and other.
Source§type Output = WildcardPathFlags
type Output = WildcardPathFlags
| operator.Source§impl BitOrAssign for WildcardPathFlags
impl BitOrAssign for WildcardPathFlags
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 WildcardPathFlags
impl BitXor for WildcardPathFlags
Source§impl BitXorAssign for WildcardPathFlags
impl BitXorAssign for WildcardPathFlags
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 WildcardPathFlags
impl Clone for WildcardPathFlags
impl Copy for WildcardPathFlags
Source§impl Debug for WildcardPathFlags
impl Debug for WildcardPathFlags
Source§impl Default for WildcardPathFlags
impl Default for WildcardPathFlags
impl Eq for WildcardPathFlags
Source§impl Extend<WildcardPathFlags> for WildcardPathFlags
impl Extend<WildcardPathFlags> for WildcardPathFlags
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 WildcardPathFlags
impl Flags for WildcardPathFlags
Source§const FLAGS: &'static [Flag<WildcardPathFlags>]
const FLAGS: &'static [Flag<WildcardPathFlags>]
Source§fn from_bits_retain(bits: u32) -> WildcardPathFlags
fn from_bits_retain(bits: u32) -> WildcardPathFlags
Source§fn all_named() -> WildcardPathFlags
fn all_named() -> WildcardPathFlags
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<WildcardPathFlags> for WildcardPathFlags
impl FromIterator<WildcardPathFlags> for WildcardPathFlags
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 WildcardPathFlags
impl Hash for WildcardPathFlags
Source§impl IntoIterator for WildcardPathFlags
impl IntoIterator for WildcardPathFlags
Source§impl LowerHex for WildcardPathFlags
impl LowerHex for WildcardPathFlags
Source§impl Not for WildcardPathFlags
impl Not for WildcardPathFlags
Source§impl Octal for WildcardPathFlags
impl Octal for WildcardPathFlags
Source§impl PartialEq for WildcardPathFlags
impl PartialEq for WildcardPathFlags
Source§impl PublicFlags for WildcardPathFlags
impl PublicFlags for WildcardPathFlags
impl StructuralPartialEq for WildcardPathFlags
Source§impl Sub for WildcardPathFlags
impl Sub for WildcardPathFlags
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 = WildcardPathFlags
type Output = WildcardPathFlags
- operator.Source§impl SubAssign for WildcardPathFlags
impl SubAssign for WildcardPathFlags
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.