Struct VpnPluginInfo 

pub struct VpnPluginInfo { /* private fields */ }

GLib type: GObject with reference counted clone semantics.

Implementations

impl VpnPluginInfo

pub fn from_file(filename: &str) -> Result<VpnPluginInfo, Error>

Available on crate feature v1_2 only.

Read the plugin info from file @filename. Does not do any further verification on the file. You might want to check file permissions and ownership of the file.

filename

filename to read.

Returns

None if there is any error or a newly created #NMVpnPluginInfo instance.

pub fn new_search_file( name: Option<&str>, service: Option<&str>, ) -> Option<VpnPluginInfo>

Available on crate feature v1_4 only.

This has the same effect as doing a full nm_vpn_plugin_info_list_load() followed by a search for the first matching VPN plugin info that has the given @name and/or @service.

name

the name to search for. Either @name or @service must be present.

service

the service to search for. Either @name or @service must be present.

Returns

a newly created instance of plugin info or None if no matching value was found.

pub fn builder() -> VpnPluginInfoBuilder

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

This method returns an instance of VpnPluginInfoBuilder which can be used to create VpnPluginInfo objects.

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

Available on crate feature v1_4 only.

Returns

the aliases from the name-file.

pub fn auth_dialog(&self) -> GString

Available on crate feature v1_4 only.

Returns

the absolute path to the auth-dialog helper or None.

pub fn editor_plugin(&self) -> VpnEditorPlugin

Available on crate feature v1_2 only.

Returns

the cached #NMVpnEditorPlugin instance.

pub fn filename(&self) -> GString

Available on crate feature v1_2 only.

Returns

the filename. Can be None.

pub fn name(&self) -> GString

Available on crate feature v1_2 only.

Returns

the name. Cannot be None.

pub fn plugin(&self) -> GString

Available on crate feature v1_2 only.

Returns

the plugin. Can be None.

pub fn program(&self) -> GString

Available on crate feature v1_2 only.

Returns

the program. Can be None.

pub fn service(&self) -> GString

Available on crate feature v1_4 only.

Returns

the service. Cannot be None.

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

Available on crate feature v1_2 only.

Returns

loads the plugin and returns the newly created instance. The plugin is owned by @self and can be later retrieved again via nm_vpn_plugin_info_get_editor_plugin(). You can load the plugin only once, unless you reset the state via nm_vpn_plugin_info_set_editor_plugin().

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

Available on crate feature v1_2 only.

group

group name

key

name of the property

Returns

#NMVpnPluginInfo is internally a #GKeyFile. Returns the matching property.

pub fn set_editor_plugin(&self, plugin: Option<&impl IsA<VpnEditorPlugin>>)

Available on crate feature v1_2 only.

Set the internal plugin instance. If None, only clear the previous instance.

plugin

plugin instance

pub fn supports_hints(&self) -> bool

Available on crate feature v1_4 only.

Returns

true if the supports hints for secret requests, otherwise false

pub fn supports_multiple(&self) -> bool

Available on crate feature v1_42 only.

Returns

true if the service supports multiple instances with different bus names, otherwise false

pub fn list_add( list: &[VpnPluginInfo], plugin_info: &VpnPluginInfo, ) -> Result<(), Error>

Available on crate feature v1_2 only.

list

list of plugins

plugin_info

instance to add

Returns

true if the plugin was added to @list. This will fail to add duplicate plugins.

pub fn list_find_by_filename( list: &[VpnPluginInfo], filename: &str, ) -> VpnPluginInfo

Available on crate feature v1_2 only.

list

list of plugins

filename

filename to search

Returns

the first plugin with a matching @filename (or None).

pub fn list_find_by_name(list: &[VpnPluginInfo], name: &str) -> VpnPluginInfo

Available on crate feature v1_2 only.

list

list of plugins

name

name to search

Returns

the first plugin with a matching @name (or None).

pub fn list_find_by_service( list: &[VpnPluginInfo], service: &str, ) -> VpnPluginInfo

Available on crate feature v1_2 only.

list

list of plugins

service

service to search. This can be the main service-type or one of the provided aliases.

Returns

the first plugin with a matching @service (or None).

pub fn list_find_service_type(list: &[VpnPluginInfo], name: &str) -> GString

Available on crate feature v1_4 only.

A VPN plugin provides one or several service-types, like org.freedesktop.NetworkManager.libreswan Certain plugins provide more then one service type, via aliases (org.freedesktop.NetworkManager.openswan). This function looks up a service-type (or an alias) based on a name.

Preferably, the name can be a full service-type/alias of an installed plugin. Otherwise, it can be the name of a VPN plugin (in which case, the primary, non-aliased service-type is returned). Otherwise, it can be one of several well known short-names (which is a hard-coded list of types in libnm). On success, this returns a full qualified service-type (or an alias). It doesn’t say, that such an plugin is actually available, but it could be retrieved via nm_vpn_plugin_info_list_find_by_service().

list

a possibly empty #GSList of #NMVpnPluginInfo instances

name

a name to lookup the service-type.

Returns

the resolved service-type or None on failure.

pub fn list_get_service_types( list: &[VpnPluginInfo], only_existing: bool, with_abbreviations: bool, ) -> Vec<GString>

Available on crate feature v1_4 only.

list

a possibly empty #GSList of #NMVpnPluginInfo

only_existing

only include results that are actually in @list. Otherwise, the result is extended with a hard-code list or well-known plugins

with_abbreviations

if false, only full service types are returned. Otherwise, this also includes abbreviated names that can be used with nm_vpn_plugin_info_list_find_service_type().

Returns

a None terminated strv list of strings. The list itself and the values must be freed with g_strfreev().

pub fn list_load() -> Vec<VpnPluginInfo>

Available on crate feature v1_2 only.

Returns

list of plugins loaded from the default directories rejecting duplicates.

pub fn list_remove(list: &[VpnPluginInfo], plugin_info: &VpnPluginInfo) -> bool

Available on crate feature v1_2 only.

Remove @plugin_info from @list.

list

list of plugins

plugin_info

instance

Returns

true if @plugin_info was in @list and successfully removed.

pub fn validate_filename(filename: &str) -> bool

Available on crate feature v1_2 only.

Regular name files have a certain pattern. That basically means they have the file extension “name”. Check if @filename is valid according to that pattern.

filename

the filename to check

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

Available on crate feature v1_2 only.

Trait Implementations

impl Clone for VpnPluginInfo

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 VpnPluginInfo

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

Formats the value using the given formatter.

impl Display for VpnPluginInfo

Available on crate feature v1_2 only.

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

Formats the value using the given formatter.

impl HasParamSpec for VpnPluginInfo

type ParamSpec = ParamSpecObject

type SetValue = VpnPluginInfo

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for VpnPluginInfo

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 VpnPluginInfo

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 VpnPluginInfo

type Parent = Object

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

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 VpnPluginInfo

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 VpnPluginInfo

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for VpnPluginInfo