Struct WireGuardPeer 

pub struct WireGuardPeer { /* private fields */ }

Available on crate feature v1_16 only.

The settings of one WireGuard peer.

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

Implementations

impl WireGuardPeer

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

impl WireGuardPeer

pub fn new() -> WireGuardPeer

Returns

a new, default, unsealed #NMWireGuardPeer instance.

pub fn append_allowed_ip(&self, allowed_ip: &str, accept_invalid: bool) -> bool

Appends @allowed_ip setting to the list. This does not check for duplicates and always appends @allowed_ip to the end of the list. If @allowed_ip is valid, it will be normalized and a modified for might be appended. If @allowed_ip is invalid, it will still be appended, but later verification will fail.

It is a bug trying to modify a sealed #NMWireGuardPeer instance.

allowed_ip

the allowed-ip entry to set.

accept_invalid

if true, also invalid @allowed_ip value will be appended. Otherwise, the function does nothing in face of invalid values and returns false.

Returns

true if the value is a valid allowed-ips value, false otherwise. Depending on @accept_invalid, also invalid values are added.

pub fn clear_allowed_ips(&self)

Removes all allowed-ip entries.

It is a bug trying to modify a sealed #NMWireGuardPeer instance.

pub fn cmp( &self, b: Option<&WireGuardPeer>, compare_flags: SettingCompareFlags, ) -> i32

b

the other #NMWireGuardPeer to compare.

compare_flags

#NMSettingCompareFlags to affect the comparison.

Returns

zero of the two instances are equivalent or a non-zero integer otherwise. This defines a total ordering over the peers. Whether a peer is sealed or not, does not affect the comparison.

pub fn allowed_ip(&self, idx: u32, out_is_valid: bool) -> Option<GString>

idx

the index from zero to (allowed-ips-len - 1) to retrieve.

out_is_valid

true if the returned value is a valid allowed-ip setting. This parameter is wrongly not marked as (out) argument, it is thus not accessible via introspection. This cannot be fixed without breaking API for introspection users.

Returns

the allowed-ip setting at index @idx. If @idx is out of range, None will be returned.

pub fn allowed_ips_len(&self) -> u32

Returns

the number of allowed-ips entries.

pub fn endpoint(&self) -> GString

Returns

the endpoint or None if none was set.

pub fn persistent_keepalive(&self) -> u16

Returns

get the persistent-keepalive setting in seconds. Set to zero to disable keep-alive.

pub fn preshared_key(&self) -> GString

Returns

the preshared key or None if unset.

pub fn preshared_key_flags(&self) -> SettingSecretFlags

Returns

get the secret flags for the preshared-key.

pub fn public_key(&self) -> GString

Returns

the public key or None if unset.

pub fn is_sealed(&self) -> bool

Returns

whether @self is sealed or not.

pub fn is_valid( &self, check_non_secrets: bool, check_secrets: bool, ) -> Result<(), Error>

check_non_secrets

if true, secret properties are validated. Otherwise, they are ignored for this purpose.

check_secrets

if true, non-secret properties are validated. Otherwise, they are ignored for this purpose.

Returns

true if the peer is valid or fails with an error reason.

pub fn new_clone(&self, with_secrets: bool) -> WireGuardPeer

with_secrets

if true, the preshared-key secrets are copied as well. Otherwise, they will be removed.

Returns

a clone of @self. This instance is always unsealed.

pub fn remove_allowed_ip(&self, idx: u32) -> bool

Removes the allowed-ip at the given @idx. This shifts all following entries one index down.

It is a bug trying to modify a sealed #NMWireGuardPeer instance.

idx

the index from zero to (allowed-ips-len - 1) to retrieve. If the index is out of range, false is returned and nothing is done.

Returns

true if @idx was valid and the allowed-ip was removed. false otherwise, and the peer will not be changed.

pub fn seal(&self)

Seal the #NMWireGuardPeer instance. Afterwards, it is a bug to call all functions that modify the instance (except ref/unref). A sealed instance cannot be unsealed again, but you can create an unsealed copy with nm_wireguard_peer_new_clone().

pub fn set_endpoint(&self, endpoint: &str, allow_invalid: bool) -> bool

Sets or clears the endpoint of @self.

It is a bug trying to modify a sealed #NMWireGuardPeer instance.

endpoint

the socket address endpoint to set or None.

allow_invalid

if true, also invalid values are set. If false, the function does nothing for invalid @endpoint arguments.

Returns

true if the endpoint is None or valid. For an invalid @endpoint argument, false is returned. Depending on @allow_invalid, the instance will be modified.

pub fn set_persistent_keepalive(&self, persistent_keepalive: u16)

It is a bug trying to modify a sealed #NMWireGuardPeer instance.

persistent_keepalive

the keep-alive value to set.

pub fn set_preshared_key( &self, preshared_key: Option<&str>, accept_invalid: bool, ) -> bool

Reset the preshared key. Note that if the preshared key is valid, it will be normalized (which may or may not modify the set value).

Note that the preshared-key is a secret and consequently has corresponding preshared-key-flags property. This is so that secrets can be optional and requested on demand from a secret-agent. Also, an invalid preshared-key may optionally cause nm_wireguard_peer_is_valid() to fail or it may be accepted.

It is a bug trying to modify a sealed #NMWireGuardPeer instance.

preshared_key

the new preshared key or None to clear the preshared key.

accept_invalid

whether to allow setting the key to an invalid value. If false, @self is unchanged if the key is invalid and if false is returned.

Returns

true if the preshared-key is valid, otherwise false. None is considered a valid value. If the key is invalid, it depends on @accept_invalid whether the previous value was reset.

pub fn set_preshared_key_flags(&self, preshared_key_flags: SettingSecretFlags)

It is a bug trying to modify a sealed #NMWireGuardPeer instance.

preshared_key_flags

the secret flags to set.

pub fn set_public_key( &self, public_key: Option<&str>, accept_invalid: bool, ) -> bool

Reset the public key. Note that if the public key is valid, it will be normalized (which may or may not modify the set value).

It is a bug trying to modify a sealed #NMWireGuardPeer instance.

public_key

the new public key or None to clear the public key.

accept_invalid

if true and @public_key is not None and invalid, then do not modify the instance.

Returns

true if the key was valid or None. Returns false for invalid keys. Depending on @accept_invalid will an invalid key be set or not.

Trait Implementations

impl Clone for WireGuardPeer

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 WireGuardPeer

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

Formats the value using the given formatter.

impl Default for WireGuardPeer

fn default() -> Self

Returns the “default value” for a type.

impl From<WireGuardPeer> for Value

fn from(s: WireGuardPeer) -> Self

Converts to this type from the input type.

impl HasParamSpec for WireGuardPeer

type ParamSpec = ParamSpecBoxed

type SetValue = WireGuardPeer

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for WireGuardPeer

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 WireGuardPeer

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for WireGuardPeer

impl StructuralPartialEq for WireGuardPeer