Struct IPRoute 

pub struct IPRoute { /* private fields */ }

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl IPRoute

pub fn as_ptr(&self) -> *mut NMIPRoute

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut NMIPRoute) -> &Self

Borrows the underlying C value.

impl IPRoute

pub fn new( family: i32, dest: &str, prefix: u32, next_hop: Option<&str>, metric: i64, ) -> Result<IPRoute, Error>

Creates a new #NMIPRoute object.

family

the IP address family (AF_INET or AF_INET6)

dest

the IP address of the route’s destination

prefix

the address prefix length

next_hop

the IP address of the next hop (or None)

metric

the route metric (or -1 for “default”)

Returns

the new #NMIPRoute object, or None on error

pub fn equal_full(&self, other: &IPRoute, cmp_flags: u32) -> bool

Available on crate feature v1_10 only.

Determines if two #NMIPRoute objects contain the same destination, prefix, next hop, and metric.

other

the #NMIPRoute to compare @self to.

cmp_flags

tune how to compare attributes. Currently, only NM_IP_ROUTE_EQUAL_CMP_FLAGS_NONE (0) and NM_IP_ROUTE_EQUAL_CMP_FLAGS_WITH_ATTRS (1) is supported.

Returns

true if the objects contain the same values, false if they do not.

pub fn attribute_names(&self) -> Vec<GString>

Gets an array of attribute names defined on @self.

Returns

a None-terminated array of attribute names

pub fn dest(&self) -> GString

Gets the IP destination address property of this route object.

Returns

the IP address of the route’s destination

pub fn family(&self) -> i32

Gets the IP address family (eg, AF_INET) property of this route object.

Returns

the IP address family

pub fn metric(&self) -> i64

Gets the route metric property of this route object; lower values indicate “better” or more preferred routes; -1 indicates “default” (meaning NetworkManager will set it appropriately).

Returns

the route metric

pub fn next_hop(&self) -> GString

Gets the IP address of the next hop of this route; this will be None if the route has no next hop.

Returns

the IP address of the next hop, or None if this is a device route.

pub fn prefix(&self) -> u32

Gets the IP prefix (ie “24” or “30” etc) of this route.

Returns

the IP prefix

pub fn set_dest(&self, dest: &str)

Sets the destination property of this route object.

@dest must be a valid address of @self’s family. If you aren’t sure you have a valid address, use nm_inet_is_valid() to check it.

dest

the route’s destination, as a string

pub fn set_metric(&self, metric: i64)

Sets the metric property of this route object.

metric

the route metric (or -1 for “default”)

pub fn set_next_hop(&self, next_hop: Option<&str>)

Sets the next-hop property of this route object.

@next_hop (if non-None) must be a valid address of @self’s family. If you aren’t sure you have a valid address, use nm_utils_ipaddr_valid() to check it.

next_hop

the route’s next hop, as a string

pub fn set_prefix(&self, prefix: u32)

Sets the prefix property of this route object.

prefix

the route prefix

pub fn variant_attribute_spec() -> VariantAttributeSpec

Available on crate feature v1_8 only.

Returns

the specifiers for route attributes

Trait Implementations

impl Clone for IPRoute

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for IPRoute

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

Formats the value using the given formatter.

impl From<IPRoute> for Value

fn from(s: IPRoute) -> Self

Converts to this type from the input type.

impl HasParamSpec for IPRoute

type ParamSpec = ParamSpecBoxed

type SetValue = IPRoute

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

type BuilderFn = fn(&str) -> ParamSpecBoxedBuilder<'_, IPRoute>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for IPRoute

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 IPRoute

fn cmp(&self, other: &IPRoute) -> 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 IPRoute

fn eq(&self, other: &Self) -> 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 IPRoute

fn partial_cmp(&self, other: &IPRoute) -> 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 IPRoute

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for IPRoute