Struct interfaces::flags::InterfaceFlags
source · pub struct InterfaceFlags(_);
Expand description
Represents a set of flags that describe the state of an interface. This corresponds to the
flags that are returned from the SIOCGIFFLAGS
syscall
Implementations§
source§impl InterfaceFlags
impl InterfaceFlags
sourcepub const IFF_BROADCAST: Self = _
pub const IFF_BROADCAST: Self = _
Broadcast address valid.
sourcepub const IFF_LOOPBACK: Self = _
pub const IFF_LOOPBACK: Self = _
Is a loopback net.
sourcepub const IFF_POINTOPOINT: Self = _
pub const IFF_POINTOPOINT: Self = _
Interface is point-to-point link.
sourcepub const IFF_NOTRAILERS: Self = _
pub const IFF_NOTRAILERS: Self = _
Avoid use of trailers.
sourcepub const IFF_RUNNING: Self = _
pub const IFF_RUNNING: Self = _
Resources allocated.
sourcepub const IFF_PROMISC: Self = _
pub const IFF_PROMISC: Self = _
Receive all packets.
sourcepub const IFF_ALLMULTI: Self = _
pub const IFF_ALLMULTI: Self = _
Receive all multicast packets.
sourcepub const IFF_MASTER: Self = _
pub const IFF_MASTER: Self = _
Master of a load balancer.
sourcepub const IFF_MULTICAST: Self = _
pub const IFF_MULTICAST: Self = _
Supports multicast.
sourcepub const IFF_PORTSEL: Self = _
pub const IFF_PORTSEL: Self = _
Can set media type.
sourcepub const IFF_AUTOMEDIA: Self = _
pub const IFF_AUTOMEDIA: Self = _
Auto media select active.
sourcepub const IFF_DYNAMIC: Self = _
pub const IFF_DYNAMIC: Self = _
Dialup device with changing addresses.
source§impl InterfaceFlags
impl InterfaceFlags
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Returns the raw value of the flags currently stored.
Examples found in repository?
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
fn main() {
let mut ifs = Interface::get_all().expect("could not get interfaces");
ifs.sort_by(|a, b| a.name.cmp(&b.name));
// Find the maximum alignment for our interface names.
let max_align = ifs.iter().map(|i| i.name.len() + 2).max().unwrap();
let full_align = iter::repeat(' ').take(max_align).collect::<String>();
for i in ifs.iter() {
let name_align = iter::repeat(' ')
.take(max_align - i.name.len() - 2)
.collect::<String>();
// Build the first line by printing the interface flags.
let first_line = {
let mut buf = String::new();
buf.push_str(&*format!("flags={} <", i.flags.bits()));
let mut flag_strs = vec![];
for &(f, s) in NAME_MAPPINGS.iter() {
if i.flags.contains(f) {
flag_strs.push(s);
}
}
buf.push_str(&*flag_strs.join(","));
buf.push_str(&*format!("> mtu {}", i.get_mtu().unwrap_or(0)));
buf
};
println!("{}: {}{}", i.name, name_align, first_line);
if i.flags.contains(InterfaceFlags::IFF_LOOPBACK) {
println!("{}loop (Local Loopback)", full_align);
} else {
if let Ok(addr) = i.hardware_addr() {
println!("{}ether {}", full_align, addr);
}
}
for addr in i.addresses.iter() {
let raddr = match addr.addr {
Some(a) => a,
None => continue,
};
let prefix = match addr.kind {
Kind::Ipv4 => "inet",
Kind::Ipv6 => "inet6",
_ => continue,
};
println!("{}{} {}", full_align, prefix, format_addr(&raddr));
}
}
}
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get the value for a flag from its stringified name.
Names are case-sensitive, so must correspond exactly to the identifier given to the flag.
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
.
Examples found in repository?
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
fn main() {
let mut ifs = Interface::get_all().expect("could not get interfaces");
ifs.sort_by(|a, b| a.name.cmp(&b.name));
// Find the maximum alignment for our interface names.
let max_align = ifs.iter().map(|i| i.name.len() + 2).max().unwrap();
let full_align = iter::repeat(' ').take(max_align).collect::<String>();
for i in ifs.iter() {
let name_align = iter::repeat(' ')
.take(max_align - i.name.len() - 2)
.collect::<String>();
// Build the first line by printing the interface flags.
let first_line = {
let mut buf = String::new();
buf.push_str(&*format!("flags={} <", i.flags.bits()));
let mut flag_strs = vec![];
for &(f, s) in NAME_MAPPINGS.iter() {
if i.flags.contains(f) {
flag_strs.push(s);
}
}
buf.push_str(&*flag_strs.join(","));
buf.push_str(&*format!("> mtu {}", i.get_mtu().unwrap_or(0)));
buf
};
println!("{}: {}{}", i.name, name_align, first_line);
if i.flags.contains(InterfaceFlags::IFF_LOOPBACK) {
println!("{}loop (Local Loopback)", full_align);
} else {
if let Ok(addr) = i.hardware_addr() {
println!("{}ether {}", full_align, addr);
}
}
for addr in i.addresses.iter() {
let raddr = match addr.addr {
Some(a) => a,
None => continue,
};
let prefix = match addr.kind {
Kind::Ipv4 => "inet",
Kind::Ipv6 => "inet6",
_ => continue,
};
println!("{}{} {}", full_align, prefix, format_addr(&raddr));
}
}
}
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
sourcepub const fn iter(&self) -> Iter<InterfaceFlags>
pub const fn iter(&self) -> Iter<InterfaceFlags>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<InterfaceFlags>
pub const fn iter_names(&self) -> IterNames<InterfaceFlags>
Iterate over enabled flag values with their stringified names.
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 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 Flags for InterfaceFlags
impl Flags for InterfaceFlags
source§const FLAGS: &'static [Flag<InterfaceFlags>] = _
const FLAGS: &'static [Flag<InterfaceFlags>] = _
source§fn from_bits_retain(bits: u32) -> InterfaceFlags
fn from_bits_retain(bits: u32) -> InterfaceFlags
source§fn from_bits(bits: Self::Bits) -> Option<Self>
fn from_bits(bits: Self::Bits) -> Option<Self>
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere Self: Sized,
true
if there are flags common to both self
and other
.source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
true
if all of the flags in other
are contained within self
.source§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where Self: Sized,
source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
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
source§fn complement(self) -> Self
fn complement(self) -> Self
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 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 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 PublicFlags for InterfaceFlags
impl PublicFlags for InterfaceFlags
source§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.