Struct SettingTun 

pub struct SettingTun { /* private fields */ }

Tunnel Settings

Properties

group

The group ID which will own the device. If set to None everyone will be able to use the device.

Readable | Writeable

mode

The operating mode of the virtual device. Allowed values are SettingTunMode::Tun to create a layer 3 device and SettingTunMode::Tap to create an Ethernet-like layer 2 one.

Readable | Writeable

multi-queue

If the property is set to true, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.

Readable | Writeable

owner

The user ID which will own the device. If set to None everyone will be able to use the device.

Readable | Writeable

pi

If true the interface will prepend a 4 byte header describing the physical interface to the packets.

Readable | Writeable

vnet-hdr

If true the IFF_VNET_HDR the tunnel packets will include a virtio network header.

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 SettingTun

pub fn new() -> SettingTun

Available on crate feature v1_2 only.

Creates a new #NMSettingTun object with default values.

Returns

the new empty #NMSettingTun object

pub fn builder() -> SettingTunBuilder

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

This method returns an instance of SettingTunBuilder which can be used to create SettingTun objects.

pub fn group(&self) -> GString

Available on crate feature v1_2 only.

Returns

the #NMSettingTun:group property of the setting

pub fn mode(&self) -> SettingTunMode

Available on crate feature v1_2 only.

Returns

the #NMSettingTun:mode property of the setting

pub fn is_multi_queue(&self) -> bool

Available on crate feature v1_2 only.

Returns

the #NMSettingTun:multi-queue property of the setting

pub fn owner(&self) -> GString

Available on crate feature v1_2 only.

Returns

the #NMSettingTun:owner property of the setting

pub fn is_pi(&self) -> bool

Available on crate feature v1_2 only.

Returns

the #NMSettingTun:pi property of the setting

pub fn is_vnet_hdr(&self) -> bool

Available on crate feature v1_2 only.

Returns

the #NMSettingTun:vnet_hdr property of the setting

pub fn set_group(&self, group: Option<&str>)

Available on crate feature v1_2 only.

The group ID which will own the device. If set to None everyone will be able to use the device.

pub fn set_mode(&self, mode: u32)

Available on crate feature v1_2 only.

The operating mode of the virtual device. Allowed values are SettingTunMode::Tun to create a layer 3 device and SettingTunMode::Tap to create an Ethernet-like layer 2 one.

pub fn set_multi_queue(&self, multi_queue: bool)

Available on crate feature v1_2 only.

If the property is set to true, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.

pub fn set_owner(&self, owner: Option<&str>)

Available on crate feature v1_2 only.

The user ID which will own the device. If set to None everyone will be able to use the device.

pub fn set_pi(&self, pi: bool)

Available on crate feature v1_2 only.

If true the interface will prepend a 4 byte header describing the physical interface to the packets.

pub fn set_vnet_hdr(&self, vnet_hdr: bool)

Available on crate feature v1_2 only.

If true the IFF_VNET_HDR the tunnel packets will include a virtio network header.

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

Available on crate feature v1_2 only.

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

Available on crate feature v1_2 only.

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

Available on crate feature v1_2 only.

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

Available on crate feature v1_2 only.

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

Available on crate feature v1_2 only.

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

Available on crate feature v1_2 only.

Trait Implementations

impl Clone for SettingTun

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 SettingTun

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

Formats the value using the given formatter.

impl Default for SettingTun

Available on crate feature v1_2 only.

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SettingTun

type ParamSpec = ParamSpecObject

type SetValue = SettingTun

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SettingTun

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 SettingTun

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 SettingTun

type Parent = Setting

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

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 SettingTun

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 SettingTun

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SettingTun

impl IsA<Setting> for SettingTun