Enum Metered 

#[non_exhaustive]
pub enum Metered {
    Unknown,
    Yes,
    No,
    GuessYes,
    GuessNo,
}

Available on crate feature v1_2 only.

The NMMetered enum has two different purposes: one is to configure “connection.metered” setting of a connection profile in #NMSettingConnection, and the other is to express the actual metered state of the #NMDevice at a given moment.

For the connection profile only #NM_METERED_UNKNOWN, #NM_METERED_NO and #NM_METERED_YES are allowed.

The device’s metered state at runtime is determined by the profile which is currently active. If the profile explicitly specifies #NM_METERED_NO or #NM_METERED_YES, then the device’s metered state is as such. If the connection profile leaves it undecided at #NM_METERED_UNKNOWN (the default), then NetworkManager tries to guess the metered state, for example based on the device type or on DHCP options (like Android devices exposing a “ANDROID_METERED” DHCP vendor option). This then leads to either #NM_METERED_GUESS_NO or #NM_METERED_GUESS_YES.

Most applications probably should treat the runtime state #NM_METERED_GUESS_YES like #NM_METERED_YES, and all other states as not metered.

Note that the per-device metered states are then combined to a global metered state. This is basically the metered state of the device with the best default route. However, that generalization of a global metered state may not be correct if the default routes for IPv4 and IPv6 are on different devices, or if policy routing is configured. In general, the global metered state tries to express whether the traffic is likely metered, but since that depends on the traffic itself, there is not one answer in all cases. Hence, an application may want to consider the per-device’s metered states.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unknown

The metered status is unknown

Yes

Metered, the value was explicitly configured

No

Not metered, the value was explicitly configured

GuessYes

Metered, the value was guessed

GuessNo

Not metered, the value was guessed

Trait Implementations

impl Clone for Metered

fn clone(&self) -> Metered

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metered

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

Formats the value using the given formatter.

impl From<Metered> for Value

fn from(v: Metered) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for Metered

type Checker = GenericValueTypeChecker<Metered>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for Metered

type ParamSpec = ParamSpecEnum

type SetValue = Metered

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str, Metered) -> ParamSpecEnumBuilder<'_, Metered>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Metered

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Metered

fn cmp(&self, other: &Metered) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Metered

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Metered

fn partial_cmp(&self, other: &Metered) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Metered

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for Metered

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for Metered

type Type = Metered

Type to get the Type from.

impl Copy for Metered

impl Eq for Metered

impl StructuralPartialEq for Metered