Struct IPRoutingRule 

pub struct IPRoutingRule { /* private fields */ }

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

Implementations

impl IPRoutingRule

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

impl IPRoutingRule

pub fn new(addr_family: i32) -> IPRoutingRule

Available on crate feature v1_18 only.

addr_family

the address family of the routing rule. Must be either AF_INET (2) or AF_INET6 (10).

Returns

a newly created rule instance with the provided address family. The instance is unsealed.

pub fn cmp(&self, other: Option<&IPRoutingRule>) -> i32

Available on crate feature v1_18 only.

other

the other #NMIPRoutingRule instance to compare

Returns

zero, a positive, or a negative integer to indicate equality or how the arguments compare.

pub fn action(&self) -> u8

Available on crate feature v1_18 only.

Returns

the set action.

pub fn addr_family(&self) -> i32

Available on crate feature v1_18 only.

Returns

the address family of the rule. Either AF_INET or AF_INET6.

pub fn destination_port_end(&self) -> u16

Available on crate feature v1_18 only.

Returns

the destination port end setting.

pub fn destination_port_start(&self) -> u16

Available on crate feature v1_18 only.

Returns

the destination port start setting.

pub fn from(&self) -> GString

Available on crate feature v1_18 only.

Returns

the set from/src parameter or None, if no value is set.

pub fn from_len(&self) -> u8

Available on crate feature v1_18 only.

Returns

the set prefix length for the from/src parameter.

pub fn fwmark(&self) -> u32

Available on crate feature v1_18 only.

Returns

the fwmark setting.

pub fn fwmask(&self) -> u32

Available on crate feature v1_18 only.

Returns

the fwmask setting.

pub fn iifname(&self) -> GString

Available on crate feature v1_18 only.

Returns

the set iifname or None if unset.

pub fn inverts(&self) -> bool

Available on crate feature v1_18 only.

Returns

the “invert” setting of the rule.

pub fn ipproto(&self) -> u8

Available on crate feature v1_18 only.

Returns

the ipproto of the rule.

pub fn oifname(&self) -> GString

Available on crate feature v1_18 only.

Returns

the set oifname or None if unset.

pub fn priority(&self) -> i64

Available on crate feature v1_18 only.

Returns

the priority. A valid priority is in the range from 0 to G_MAXUINT32. If unset, -1 is returned.

pub fn source_port_end(&self) -> u16

Available on crate feature v1_18 only.

Returns

the source port end setting.

pub fn source_port_start(&self) -> u16

Available on crate feature v1_18 only.

Returns

the source port start setting.

pub fn suppress_prefixlength(&self) -> i32

Available on crate feature v1_20 only.

Returns

the suppress_prefixlength of the rule. -1 means that the value is unset.

pub fn table(&self) -> u32

Available on crate feature v1_18 only.

Returns

the set table.

pub fn to(&self) -> GString

Available on crate feature v1_18 only.

Returns

the set to/dst parameter or None, if no value is set.

pub fn to_len(&self) -> u8

Available on crate feature v1_18 only.

Returns

the set prefix length for the to/dst parameter.

pub fn tos(&self) -> u8

Available on crate feature v1_18 only.

Returns

the tos of the rule.

pub fn is_sealed(&self) -> bool

Available on crate feature v1_18 only.

Returns

whether @self is sealed. Once sealed, an instance cannot be modified nor unsealed.

pub fn new_clone(&self) -> IPRoutingRule

Available on crate feature v1_18 only.

Since 1.42, ref-counting of #NMIPRoutingRule is thread-safe.

Returns

a newly created rule instance with the same settings as @self. Note that the instance will always be unsealed.

pub fn seal(&self)

Available on crate feature v1_18 only.

Seals the routing rule. Afterwards, the instance can no longer be modified, and it is a bug to call any of the accessors that would modify the rule. If @self was already sealed, this has no effect.

pub fn set_action(&self, action: u8)

Available on crate feature v1_18 only.

Note that currently only certain actions are allowed. nm_ip_routing_rule_validate() will reject unsupported actions as invalid.

action

the action to set

pub fn set_destination_port(&self, start: u16, end: u16)

Available on crate feature v1_18 only.

start

the start port to set.

end

the end port to set.

pub fn set_from(&self, from: Option<&str>)

Available on crate feature v1_18 only.

Setting invalid values is accepted, but will later fail during nm_ip_routing_rule_validate().

from

the from/src address to set. The address family must match.

len

the corresponding prefix length of the address.

pub fn set_fwmark(&self, fwmark: u32, fwmask: u32)

Available on crate feature v1_18 only.

fwmark

the fwmark

fwmask

the fwmask

pub fn set_iifname(&self, iifname: Option<&str>)

Available on crate feature v1_18 only.

The name supports C backslash escaping for non-UTF-8 characters. Note that nm_ip_routing_rule_from_string() too uses backslash escaping when tokenizing the words by whitespace. So, in string representation you’d get double backslashes.

iifname

the iifname to set or None to unset.

pub fn set_invert(&self, invert: bool)

Available on crate feature v1_18 only.

invert

the new value to set

pub fn set_ipproto(&self, ipproto: u8)

Available on crate feature v1_18 only.

ipproto

the ipproto to set

pub fn set_oifname(&self, oifname: Option<&str>)

Available on crate feature v1_18 only.

The name supports C backslash escaping for non-UTF-8 characters. Note that nm_ip_routing_rule_from_string() too uses backslash escaping when tokenizing the words by whitespace. So, in string representation you’d get double backslashes.

oifname

the oifname to set or None to unset.

pub fn set_priority(&self, priority: i64)

Available on crate feature v1_18 only.

A valid priority ranges from 0 to G_MAXUINT32. “-1” is also allowed to reset the priority. It is a bug calling this function with any other value.

priority

the priority to set

pub fn set_source_port(&self, start: u16, end: u16)

Available on crate feature v1_18 only.

start

the start port to set.

end

the end port to set.

pub fn set_suppress_prefixlength(&self, suppress_prefixlength: i32)

Available on crate feature v1_20 only.

suppress_prefixlength

the suppress_prefixlength to set. The value -1 means unset.

pub fn set_table(&self, table: u32)

Available on crate feature v1_18 only.

table

the table to set

pub fn set_to(&self, to: Option<&str>)

Available on crate feature v1_18 only.

Setting invalid values is accepted, but will later fail during nm_ip_routing_rule_validate().

to

the to/dst address to set. The address family must match.

len

the corresponding prefix length of the address. If @to is None, this valid is ignored.

pub fn set_tos(&self, tos: u8)

Available on crate feature v1_18 only.

tos

the tos to set

pub fn validate(&self) -> Result<(), Error>

Available on crate feature v1_18 only.

Returns

true if the rule validates.

Trait Implementations

impl Clone for IPRoutingRule

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 IPRoutingRule

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

Formats the value using the given formatter.

impl From<IPRoutingRule> for Value

fn from(s: IPRoutingRule) -> Self

Converts to this type from the input type.

impl HasParamSpec for IPRoutingRule

type ParamSpec = ParamSpecBoxed

type SetValue = IPRoutingRule

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for IPRoutingRule

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 IPRoutingRule

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for IPRoutingRule

impl StructuralPartialEq for IPRoutingRule