pub struct InterfaceFlags(/* private fields */);
Expand description
Bits representing the interface flags as returned by the SIOCGIFFLAGS ioctl
operation. These bitmasks are intended to track the C API definition. For
example, InterfaceFlags.UP
corresponds to IFF_UP
, etc.
Implementations§
source§impl InterfaceFlags
impl InterfaceFlags
pub const UP: Self = _
pub const BROADCAST: Self = _
pub const DEBUG: Self = _
pub const LOOPBACK: Self = _
pub const POINTTOPOINT: Self = _
pub const NOTRAILERS: Self = _
pub const RUNNING: Self = _
pub const NOARP: Self = _
pub const PROMISC: Self = _
pub const ALLMULTI: Self = _
pub const LEADER: Self = _
pub const FOLLOWER: Self = _
pub const MULTICAST: Self = _
pub const PORTSEL: Self = _
pub const AUTOMEDIA: Self = _
pub const DYNAMIC: Self = _
source§impl InterfaceFlags
impl InterfaceFlags
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 a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
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 two flags values.
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 two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
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 two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl InterfaceFlags
impl InterfaceFlags
sourcepub const fn iter(&self) -> Iter<InterfaceFlags>
pub const fn iter(&self) -> Iter<InterfaceFlags>
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<InterfaceFlags>
pub const fn iter_names(&self) -> IterNames<InterfaceFlags>
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.
source§impl InterfaceFlags
impl InterfaceFlags
pub fn has_unknown_bits(&self) -> bool
has_unknown_bits
pub fn get_unknown_bits(&self) -> u16
get_unknown_bits
Trait Implementations§
source§impl Binary for InterfaceFlags
impl Binary for InterfaceFlags
source§impl BitAnd for InterfaceFlags
impl BitAnd for InterfaceFlags
source§impl BitAndAssign for InterfaceFlags
impl BitAndAssign for InterfaceFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for InterfaceFlags
impl BitOr for InterfaceFlags
source§fn bitor(self, other: InterfaceFlags) -> Self
fn bitor(self, other: InterfaceFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = InterfaceFlags
type Output = InterfaceFlags
|
operator.source§impl BitOrAssign for InterfaceFlags
impl BitOrAssign for InterfaceFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for InterfaceFlags
impl BitXor for InterfaceFlags
source§impl BitXorAssign for InterfaceFlags
impl BitXorAssign for InterfaceFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for InterfaceFlags
impl Clone for InterfaceFlags
source§fn clone(&self) -> InterfaceFlags
fn clone(&self) -> InterfaceFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for InterfaceFlags
impl Debug for InterfaceFlags
source§impl Decode<InterfaceFlags> for InterfaceFlags
impl Decode<InterfaceFlags> for InterfaceFlags
source§impl Default for InterfaceFlags
impl Default for InterfaceFlags
source§fn default() -> InterfaceFlags
fn default() -> InterfaceFlags
source§impl Encode<InterfaceFlags> for InterfaceFlags
impl Encode<InterfaceFlags> for InterfaceFlags
source§impl Extend<InterfaceFlags> for InterfaceFlags
impl Extend<InterfaceFlags> for InterfaceFlags
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: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for InterfaceFlags
impl Flags for InterfaceFlags
source§const FLAGS: &'static [Flag<InterfaceFlags>] = _
const FLAGS: &'static [Flag<InterfaceFlags>] = _
source§fn from_bits_retain(bits: u16) -> InterfaceFlags
fn from_bits_retain(bits: u16) -> InterfaceFlags
§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read more§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where
Self: Sized,
Flags::insert
] when value
is true
or [Flags::remove
] when value
is false
.§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read more§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<InterfaceFlags> for InterfaceFlags
impl FromIterator<InterfaceFlags> for InterfaceFlags
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 InterfaceFlags
impl Hash for InterfaceFlags
source§impl IntoIterator for InterfaceFlags
impl IntoIterator for InterfaceFlags
source§impl LowerHex for InterfaceFlags
impl LowerHex for InterfaceFlags
source§impl Not for InterfaceFlags
impl Not for InterfaceFlags
source§impl Octal for InterfaceFlags
impl Octal for InterfaceFlags
source§impl Ord for InterfaceFlags
impl Ord for InterfaceFlags
source§fn cmp(&self, other: &InterfaceFlags) -> Ordering
fn cmp(&self, other: &InterfaceFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for InterfaceFlags
impl PartialEq for InterfaceFlags
source§fn eq(&self, other: &InterfaceFlags) -> bool
fn eq(&self, other: &InterfaceFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for InterfaceFlags
impl PartialOrd for InterfaceFlags
source§fn partial_cmp(&self, other: &InterfaceFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &InterfaceFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PublicFlags for InterfaceFlags
impl PublicFlags for InterfaceFlags
source§impl Sub for InterfaceFlags
impl Sub for InterfaceFlags
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
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 = InterfaceFlags
type Output = InterfaceFlags
-
operator.source§impl SubAssign for InterfaceFlags
impl SubAssign for InterfaceFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
source§impl TypeMarker for InterfaceFlags
impl TypeMarker for InterfaceFlags
§type Owned = InterfaceFlags
type Owned = InterfaceFlags
source§fn inline_align(_context: Context) -> usize
fn inline_align(_context: Context) -> usize
source§fn inline_size(_context: Context) -> usize
fn inline_size(_context: Context) -> usize
inline_align
.§fn encode_is_copy() -> bool
fn encode_is_copy() -> bool
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. Read more§fn decode_is_copy() -> bool
fn decode_is_copy() -> bool
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.source§impl UpperHex for InterfaceFlags
impl UpperHex for InterfaceFlags
source§impl ValueTypeMarker for InterfaceFlags
impl ValueTypeMarker for InterfaceFlags
§type Borrowed<'a> = InterfaceFlags
type Borrowed<'a> = InterfaceFlags
Encode<Self>
type cheaply obtainable from &Self::Owned
. There are three cases: Read moreimpl Copy for InterfaceFlags
impl Eq for InterfaceFlags
impl StructuralPartialEq for InterfaceFlags
Auto Trait Implementations§
impl Freeze for InterfaceFlags
impl RefUnwindSafe for InterfaceFlags
impl Send for InterfaceFlags
impl Sync for InterfaceFlags
impl Unpin for InterfaceFlags
impl UnwindSafe for InterfaceFlags
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)