Struct SettingVpn 

pub struct SettingVpn { /* private fields */ }

VPN Settings

Properties

data

Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.

Readable | Writeable

persistent

If the VPN service supports persistence, and this property is true, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.

Readable | Writeable

secrets

Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.

Readable | Writeable

service-type

D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.

Readable | Writeable

timeout

Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.

Readable | Writeable

user-name

If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.

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 SettingVpn

pub fn new() -> SettingVpn

Creates a new #NMSettingVpn object with default values.

Returns

the new empty #NMSettingVpn object

pub fn builder() -> SettingVpnBuilder

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

This method returns an instance of SettingVpnBuilder which can be used to create SettingVpn objects.

pub fn add_data_item(&self, key: &str, item: Option<&str>)

Establishes a relationship between @key and @item internally in the setting which may be retrieved later. Should not be used to store passwords or other secrets, which is what nm_setting_vpn_add_secret() is for.

Before 1.24, @item must not be None and not an empty string. Since 1.24, @item can be set to an empty string. It can also be set to None to unset the key. In that case, the behavior is as if calling nm_setting_vpn_remove_data_item().

key

a name that uniquely identifies the given value @item

item

the value to be referenced by @key

pub fn add_secret(&self, key: &str, secret: Option<&str>)

Establishes a relationship between @key and @secret internally in the setting which may be retrieved later.

Before 1.24, @secret must not be None and not an empty string. Since 1.24, @secret can be set to an empty string. It can also be set to None to unset the key. In that case, the behavior is as if calling nm_setting_vpn_remove_secret().

key

a name that uniquely identifies the given secret @secret

secret

the secret to be referenced by @key

pub fn foreach_data_item<P: FnMut(&str, &str)>(&self, func: P)

Iterates all data items stored in this setting. It is safe to add, remove, and modify data items inside @func, though any additions or removals made during iteration will not be part of the iteration.

func

an user provided function

pub fn foreach_secret<P: FnMut(&str, &str)>(&self, func: P)

Iterates all secrets stored in this setting. It is safe to add, remove, and modify secrets inside @func, though any additions or removals made during iteration will not be part of the iteration.

func

an user provided function

pub fn data_item(&self, key: &str) -> GString

Retrieves the data item of a key/value relationship previously established by nm_setting_vpn_add_data_item().

key

the name of the data item to retrieve

Returns

the data item, if any

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

Available on crate feature v1_12 only.

Retrieves every data key inside @self, as an array.

Returns

a None-terminated array containing each data key or None if there are no data items.

pub fn num_data_items(&self) -> u32

Gets number of key/value pairs of VPN configuration data.

Returns

the number of VPN plugin specific configuration data items

pub fn num_secrets(&self) -> u32

Gets number of VPN plugin specific secrets in the setting.

Returns

the number of VPN plugin specific secrets

pub fn is_persistent(&self) -> bool

Available on crate feature v1_42 only.

Returns

the #NMSettingVpn:persistent property of the setting

pub fn secret(&self, key: &str) -> GString

Retrieves the secret of a key/value relationship previously established by nm_setting_vpn_add_secret().

key

the name of the secret to retrieve

Returns

the secret, if any

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

Available on crate feature v1_12 only.

Retrieves every secret key inside @self, as an array.

Returns

a None-terminated array containing each secret key or None if there are no secrets.

pub fn service_type(&self) -> GString

Returns the service name of the VPN, which identifies the specific VPN plugin that should be used to connect to this VPN.

Returns

the VPN plugin’s service name

pub fn timeout(&self) -> u32

Available on crate feature v1_2 only.

Returns

the #NMSettingVpn:timeout property of the setting

pub fn user_name(&self) -> GString

Returns

the #NMSettingVpn:user-name property of the setting

pub fn remove_data_item(&self, key: &str) -> bool

Deletes a key/value relationship previously established by nm_setting_vpn_add_data_item().

key

the name of the data item to remove

Returns

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

pub fn remove_secret(&self, key: &str) -> bool

Deletes a key/value relationship previously established by nm_setting_vpn_add_secret().

key

the name of the secret to remove

Returns

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

pub fn set_persistent(&self, persistent: bool)

If the VPN service supports persistence, and this property is true, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.

pub fn set_service_type(&self, service_type: Option<&str>)

D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.

pub fn set_timeout(&self, timeout: u32)

Available on crate feature v1_2 only.

Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.

pub fn set_user_name(&self, user_name: Option<&str>)

If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.

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

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

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

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

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

Available on crate feature v1_2 only.

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

Trait Implementations

impl Clone for SettingVpn

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 SettingVpn

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

Formats the value using the given formatter.

impl Default for SettingVpn

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SettingVpn

type ParamSpec = ParamSpecObject

type SetValue = SettingVpn

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SettingVpn

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 SettingVpn

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 SettingVpn

type Parent = Setting

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

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 SettingVpn

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 SettingVpn

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SettingVpn

impl IsA<Setting> for SettingVpn