Struct SettingBond 

pub struct SettingBond { /* private fields */ }

Bonding Settings

Properties

options

Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).

Readable | Writeable

Setting

name

The setting’s name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example “ppp” or “802-11-wireless” or “802-3-ethernet”.

Readable

Implements

SettingExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl SettingBond

pub fn new() -> SettingBond

Creates a new #NMSettingBond object with default values.

Returns

the new empty #NMSettingBond object

pub fn builder() -> SettingBondBuilder

Creates a new builder-pattern struct instance to construct SettingBond objects.

This method returns an instance of SettingBondBuilder which can be used to create SettingBond objects.

pub fn add_option(&self, name: &str, value: &str) -> bool

Add an option to the table. Adding a new name replaces any existing name/value pair that may already exist.

name

name for the option

value

value for the option

Returns

returns false if either @name or @value is None, in that case the option is not set. Otherwise, the function does not fail and does not validate the arguments. All validation happens via nm_connection_verify() or do basic validation yourself with nm_setting_bond_validate_option().

Note: Before 1.30, libnm would perform basic validation of the name and the value via nm_setting_bond_validate_option() and reject the request by returning FALSE. Since 1.30, libnm no longer rejects any values as the setter is not supposed to perform validation.

pub fn num_options(&self) -> u32

Returns the number of options that should be set for this bond when it is activated. This can be used to retrieve each option individually using nm_setting_bond_get_option().

Returns

the number of bonding options

pub fn option(&self, idx: u32) -> Option<(GString, GString)>

Given an index, return the value of the bonding option at that index. Indexes are not guaranteed to be static across modifications to options done by nm_setting_bond_add_option() and nm_setting_bond_remove_option(), and should not be used to refer to options except for short periods of time such as during option iteration.

idx

index of the desired option, from 0 to nm_setting_bond_get_num_options() - 1

Returns

true on success if the index was valid and an option was found, false if the index was invalid (ie, greater than the number of options currently held by the setting)

out_name

on return, the name of the bonding option; this value is owned by the setting and should not be modified

out_value

on return, the value of the name of the bonding option; this value is owned by the setting and should not be modified

pub fn option_by_name(&self, name: &str) -> GString

Returns the value associated with the bonding option specified by @name, if it exists.

name

the option name for which to retrieve the value

Returns

the value, or None if the key/value pair was never added to the setting; the value is owned by the setting and must not be modified

pub fn option_default(&self, name: &str) -> GString

name

the name of the option

Returns

the value of the bond option if not overridden by an entry in the #NMSettingBond:options property.

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

Returns a list of valid bond options.

The @self argument is unused and may be passed as None.

Returns

a None-terminated array of strings of valid bond options.

pub fn remove_option(&self, name: &str) -> bool

Remove the bonding option referenced by @name from the internal option list.

name

name of the option to remove

Returns

true if the option was found and removed from the internal option list, false if it was not.

pub fn validate_option(name: &str, value: Option<&str>) -> bool

Checks whether @name is a valid bond option and @value is a valid value for the @name. If @value is None, the function only validates the option name.

name

the name of the option to validate

value

the value of the option to validate.

Returns

true, if the @value is valid for the given name. If the @name is not a valid option, false will be returned.

pub fn connect_options_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for SettingBond

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

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

Performs copy-assignment from source.

impl Debug for SettingBond

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

Formats the value using the given formatter.

impl Default for SettingBond

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SettingBond

type ParamSpec = ParamSpecObject

type SetValue = SettingBond

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

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, SettingBond>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SettingBond

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

where H: Hasher,

Hashes the memory address of this object.

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 SettingBond

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 ParentClassIs for SettingBond

type Parent = Setting

impl<OT: ObjectType> PartialEq<OT> for SettingBond

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType> PartialOrd<OT> for SettingBond

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 SettingBond

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SettingBond

impl IsA<Setting> for SettingBond