pub struct InterfaceFlags(/* private fields */);
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
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Examples found in repository?
22fn main() {
23 let mut ifs = Interface::get_all().expect("could not get interfaces");
24 ifs.sort_by(|a, b| a.name.cmp(&b.name));
25
26 // Find the maximum alignment for our interface names.
27 let max_align = ifs.iter().map(|i| i.name.len() + 2).max().unwrap();
28
29 let full_align = iter::repeat(' ').take(max_align).collect::<String>();
30
31 for i in ifs.iter() {
32 let name_align = iter::repeat(' ')
33 .take(max_align - i.name.len() - 2)
34 .collect::<String>();
35
36 // Build the first line by printing the interface flags.
37 let first_line = {
38 let mut buf = String::new();
39 buf.push_str(&*format!("flags={} <", i.flags.bits()));
40
41 let mut flag_strs = vec![];
42 for &(f, s) in NAME_MAPPINGS.iter() {
43 if i.flags.contains(f) {
44 flag_strs.push(s);
45 }
46 }
47
48 buf.push_str(&*flag_strs.join(","));
49 buf.push_str(&*format!("> mtu {}", i.get_mtu().unwrap_or(0)));
50
51 buf
52 };
53
54 println!("{}: {}{}", i.name, name_align, first_line);
55
56 if i.flags.contains(InterfaceFlags::IFF_LOOPBACK) {
57 println!("{}loop (Local Loopback)", full_align);
58 } else {
59 if let Ok(addr) = i.hardware_addr() {
60 println!("{}ether {}", full_align, addr);
61 }
62 }
63
64 for addr in i.addresses.iter() {
65 let raddr = match addr.addr {
66 Some(a) => a,
67 None => continue,
68 };
69
70 let prefix = match addr.kind {
71 Kind::Ipv4 => "inet",
72 Kind::Ipv6 => "inet6",
73 _ => continue,
74 };
75
76 println!("{}{} {}", full_align, prefix, format_addr(&raddr));
77 }
78 }
79}
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 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.
Examples found in repository?
22fn main() {
23 let mut ifs = Interface::get_all().expect("could not get interfaces");
24 ifs.sort_by(|a, b| a.name.cmp(&b.name));
25
26 // Find the maximum alignment for our interface names.
27 let max_align = ifs.iter().map(|i| i.name.len() + 2).max().unwrap();
28
29 let full_align = iter::repeat(' ').take(max_align).collect::<String>();
30
31 for i in ifs.iter() {
32 let name_align = iter::repeat(' ')
33 .take(max_align - i.name.len() - 2)
34 .collect::<String>();
35
36 // Build the first line by printing the interface flags.
37 let first_line = {
38 let mut buf = String::new();
39 buf.push_str(&*format!("flags={} <", i.flags.bits()));
40
41 let mut flag_strs = vec![];
42 for &(f, s) in NAME_MAPPINGS.iter() {
43 if i.flags.contains(f) {
44 flag_strs.push(s);
45 }
46 }
47
48 buf.push_str(&*flag_strs.join(","));
49 buf.push_str(&*format!("> mtu {}", i.get_mtu().unwrap_or(0)));
50
51 buf
52 };
53
54 println!("{}: {}{}", i.name, name_align, first_line);
55
56 if i.flags.contains(InterfaceFlags::IFF_LOOPBACK) {
57 println!("{}loop (Local Loopback)", full_align);
58 } else {
59 if let Ok(addr) = i.hardware_addr() {
60 println!("{}ether {}", full_align, addr);
61 }
62 }
63
64 for addr in i.addresses.iter() {
65 let raddr = match addr.addr {
66 Some(a) => a,
67 None => continue,
68 };
69
70 let prefix = match addr.kind {
71 Kind::Ipv4 => "inet",
72 Kind::Ipv6 => "inet6",
73 _ => continue,
74 };
75
76 println!("{}{} {}", full_align, prefix, format_addr(&raddr));
77 }
78 }
79}
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.
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.
Source§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§const fn clone_from(&mut self, source: &Self)
const 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)
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: u32) -> InterfaceFlags
fn from_bits_retain(bits: u32) -> InterfaceFlags
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 intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
Source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
Source§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.Source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moreSource§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.Source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.Source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moreSource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.Source§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 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 for InterfaceFlags
impl PartialEq for InterfaceFlags
Source§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.
Source§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.