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 = _
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
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<InterfaceFlags> for InterfaceFlags
impl BitAnd<InterfaceFlags> for InterfaceFlags
source§impl BitAndAssign<InterfaceFlags> for InterfaceFlags
impl BitAndAssign<InterfaceFlags> for InterfaceFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<InterfaceFlags> for InterfaceFlags
impl BitOr<InterfaceFlags> for InterfaceFlags
source§fn bitor(self, other: InterfaceFlags) -> Self
fn bitor(self, other: InterfaceFlags) -> Self
Returns the union of the two sets of flags.
§type Output = InterfaceFlags
type Output = InterfaceFlags
|
operator.source§impl BitOrAssign<InterfaceFlags> for InterfaceFlags
impl BitOrAssign<InterfaceFlags> for InterfaceFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<InterfaceFlags> for InterfaceFlags
impl BitXor<InterfaceFlags> for InterfaceFlags
source§impl BitXorAssign<InterfaceFlags> for InterfaceFlags
impl BitXorAssign<InterfaceFlags> for InterfaceFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
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 Decodable for InterfaceFlags
impl Decodable for InterfaceFlags
source§fn decode(
&mut self,
decoder: &mut Decoder<'_>,
offset: usize
) -> Result<(), Error>
fn decode( &mut self, decoder: &mut Decoder<'_>, offset: usize ) -> Result<(), Error>
self
.
Callers must ensure that offset
is a multiple of
Layout::inline_align
, and that decoder.buf
has room for reading
Layout::inline_size
bytes at offset
. Read moresource§impl Encodable for InterfaceFlags
impl Encodable for InterfaceFlags
source§fn encode(
&mut self,
encoder: &mut Encoder<'_, '_>,
offset: usize,
recursion_depth: usize
) -> Result<(), Error>
fn encode( &mut self, encoder: &mut Encoder<'_, '_>, offset: usize, recursion_depth: usize ) -> Result<(), Error>
Handle::INVALID
. Callers must ensure that offset
is a
multiple of Layout::inline_align
, and that encoder.buf
has room for
writing Layout::inline_size
bytes at offset
. Read moresource§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)
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 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
source§impl Hash for InterfaceFlags
impl Hash for InterfaceFlags
source§impl Layout for InterfaceFlags
impl Layout for 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 supports_simple_copy() -> boolwhere
Self: Sized,
fn supports_simple_copy() -> boolwhere Self: Sized,
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<InterfaceFlags> for InterfaceFlags
impl PartialEq<InterfaceFlags> 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<InterfaceFlags> for InterfaceFlags
impl PartialOrd<InterfaceFlags> 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 Sub<InterfaceFlags> for InterfaceFlags
impl Sub<InterfaceFlags> for InterfaceFlags
source§impl SubAssign<InterfaceFlags> for InterfaceFlags
impl SubAssign<InterfaceFlags> for InterfaceFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl UpperHex for InterfaceFlags
impl UpperHex for InterfaceFlags
impl Copy for InterfaceFlags
impl Eq for InterfaceFlags
impl StructuralEq for InterfaceFlags
impl StructuralPartialEq for InterfaceFlags
Auto Trait Implementations§
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> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> LayoutObject for Twhere
T: Layout,
impl<T> LayoutObject for Twhere T: Layout,
§fn inline_align(&self, context: &Context) -> usize
fn inline_align(&self, context: &Context) -> usize
Layout::inline_align
.§fn inline_size(&self, context: &Context) -> usize
fn inline_size(&self, context: &Context) -> usize
Layout::inline_size
.