Skip to main content

NetworkSnapshot

Struct NetworkSnapshot 

Source
pub struct NetworkSnapshot {
Show 13 fields pub name: Box<str>, pub kind: InterfaceKind, pub state: MetricState<LinkState>, pub addresses: Vec<InterfaceAddress>, pub mac: Option<Box<str>>, pub rx: MetricState<Rate>, pub tx: MetricState<Rate>, pub rx_packets: MetricState<Rate>, pub tx_packets: MetricState<Rate>, pub errors: MetricState<InterfaceErrors>, pub link_speed_mbps: MetricState<u64>, pub since_launch: TrafficTotals, pub os_totals: MetricState<TrafficTotals>,
}
Expand description

State of one network interface.

Fields§

§name: Box<str>

Interface name, e.g. en0 or eth0.

§kind: InterfaceKind

Classification.

§state: MetricState<LinkState>

Operational state.

§addresses: Vec<InterfaceAddress>

Assigned addresses.

§mac: Option<Box<str>>

Hardware address, where readable.

§rx: MetricState<Rate>

Receive throughput.

§tx: MetricState<Rate>

Transmit throughput.

§rx_packets: MetricState<Rate>

Received packets per second.

§tx_packets: MetricState<Rate>

Transmitted packets per second.

§errors: MetricState<InterfaceErrors>

Error and drop counters.

§link_speed_mbps: MetricState<u64>

Negotiated link speed, where the platform reports it.

§since_launch: TrafficTotals

Totals accumulated since monitrs launched.

Distinct from os_totals: this one starts at zero and is always meaningful, whereas the OS counter may have wrapped or been reset (§7.4).

§os_totals: MetricState<TrafficTotals>

The OS’s own counters, where exposed.

Implementations§

Source§

impl NetworkSnapshot

Source

pub fn utilization(&self) -> MetricState<Percent>

Link utilization, or an explicit unavailability.

Not a stored field: deriving it on demand makes it impossible to persist a utilization that was computed without a known link speed (§7.4). The higher of the two directions is used, since a duplex link saturates in whichever direction fills first.

Source

pub fn warming_up(name: Box<str>, kind: InterfaceKind) -> Self

An interface whose counters exist but whose rates need a second sample.

Trait Implementations§

Source§

impl Clone for NetworkSnapshot

Source§

fn clone(&self) -> NetworkSnapshot

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for NetworkSnapshot

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for NetworkSnapshot

Source§

fn eq(&self, other: &NetworkSnapshot) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for NetworkSnapshot

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.