Struct SettingVlan 

pub struct SettingVlan { /* private fields */ }

VLAN Settings

Properties

egress-priority-map

For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format “from:to” where both “from” and “to” are unsigned integers, ie “7:3”.

Readable | Writeable

flags

One or more flags which control the behavior and features of the VLAN interface. Flags include VlanFlags::REORDER_HEADERS (reordering of output packet headers), VlanFlags::GVRP (use of the GVRP protocol), and VlanFlags::LOOSE_BINDING (loose binding of the interface to its controller device’s operating state). VlanFlags::MVRP (use of the MVRP protocol).

The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.

Readable | Writeable

id

The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.

Readable | Writeable

ingress-priority-map

For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format “from:to” where both “from” and “to” are unsigned integers, ie “7:3”.

Readable | Writeable

parent

If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an #NMSettingWired setting with a #NMSettingWired:mac-address property.

Readable | Writeable

protocol

Specifies the VLAN protocol to use for encapsulation.

Supported values are: ‘802.1Q’, ‘802.1ad’. If not specified the default value is ‘802.1Q’.

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 SettingVlan

pub fn new() -> SettingVlan

Creates a new #NMSettingVlan object with default values.

Returns

the new empty #NMSettingVlan object

pub fn builder() -> SettingVlanBuilder

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

This method returns an instance of SettingVlanBuilder which can be used to create SettingVlan objects.

pub fn add_priority(&self, map: VlanPriorityMap, from: u32, to: u32) -> bool

Adds a priority mapping to the #NMSettingVlan:ingress_priority_map or #NMSettingVlan:egress_priority_map properties of the setting. If @from is already in the given priority map, this function will overwrite the existing entry with the new @to.

If @map is #NM_VLAN_INGRESS_MAP then @from is the incoming 802.1q VLAN Priority Code Point (PCP) value, and @to is the Linux SKB priority value.

If @map is #NM_VLAN_EGRESS_MAP then @from is the Linux SKB priority value and @to is the outgoing 802.1q VLAN Priority Code Point (PCP) value.

map

the type of priority map

from

the priority to map to @to

to

the priority to map @from to

Returns

true.

pub fn add_priority_str(&self, map: VlanPriorityMap, str: &str) -> bool

Adds a priority map entry into either the #NMSettingVlan:ingress_priority_map or the #NMSettingVlan:egress_priority_map properties. The priority map maps the Linux SKB priorities to 802.1p priorities.

map

the type of priority map

str

the string which contains a priority map, like “3:7”

Returns

true if the entry was successfully added to the list, or it overwrote the old value, false if @str is not a valid mapping.

pub fn clear_priorities(&self, map: VlanPriorityMap)

Clear all the entries from #NMSettingVlan:ingress_priority_map or #NMSettingVlan:egress_priority_map properties.

map

the type of priority map

pub fn flags(&self) -> u32

Returns

the #NMSettingVlan:flags property of the setting

pub fn id(&self) -> u32

Returns

the #NMSettingVlan:id property of the setting

pub fn num_priorities(&self, map: VlanPriorityMap) -> i32

Returns the number of entries in the #NMSettingVlan:ingress_priority_map or #NMSettingVlan:egress_priority_map properties of this setting.

map

the type of priority map

Returns

return the number of ingress/egress priority entries.

pub fn parent(&self) -> GString

Returns

the #NMSettingVlan:parent property of the setting

pub fn priority(&self, map: VlanPriorityMap, idx: u32) -> Option<(u32, u32)>

Retrieve one of the entries of the #NMSettingVlan:ingress_priority_map or #NMSettingVlan:egress_priority_map properties of this setting.

map

the type of priority map

idx

the zero-based index of the ingress/egress priority map entry

Returns

returns true if @idx is in range. Otherwise, false.

out_from

on return the value of the priority map’s ‘from’ item

out_to

on return the value of priority map’s ‘to’ item

pub fn protocol(&self) -> GString

Available on crate feature v1_42 only.

Returns

the #NMSettingVlan:protocol property of the setting

pub fn remove_priority(&self, map: VlanPriorityMap, idx: u32)

Removes the priority map at index @idx from the #NMSettingVlan:ingress_priority_map or #NMSettingVlan:egress_priority_map properties.

map

the type of priority map

idx

the zero-based index of the priority map to remove

pub fn remove_priority_by_value( &self, map: VlanPriorityMap, from: u32, to: u32, ) -> bool

Removes the priority map @form:@to from the #NMSettingVlan:ingress_priority_map or #NMSettingVlan:egress_priority_map (according to @map argument) properties.

map

the type of priority map

from

the priority to map to @to

to

the priority to map @from to

Returns

true if the priority mapping was found and removed; false if it was not.

pub fn remove_priority_str_by_value( &self, map: VlanPriorityMap, str: &str, ) -> bool

Removes the priority map @str from the #NMSettingVlan:ingress_priority_map or #NMSettingVlan:egress_priority_map (according to @map argument) properties.

map

the type of priority map

str

the string which contains a priority map, like “3:7”

Returns

true if the priority mapping was found and removed; false if it was not.

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

For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format “from:to” where both “from” and “to” are unsigned integers, ie “7:3”.

pub fn set_egress_priority_map(&self, egress_priority_map: &[&str])

For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format “from:to” where both “from” and “to” are unsigned integers, ie “7:3”.

pub fn set_flags(&self, flags: VlanFlags)

One or more flags which control the behavior and features of the VLAN interface. Flags include VlanFlags::REORDER_HEADERS (reordering of output packet headers), VlanFlags::GVRP (use of the GVRP protocol), and VlanFlags::LOOSE_BINDING (loose binding of the interface to its controller device’s operating state). VlanFlags::MVRP (use of the MVRP protocol).

The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.

pub fn set_id(&self, id: u32)

The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.

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

For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format “from:to” where both “from” and “to” are unsigned integers, ie “7:3”.

pub fn set_ingress_priority_map(&self, ingress_priority_map: &[&str])

For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format “from:to” where both “from” and “to” are unsigned integers, ie “7:3”.

pub fn set_parent(&self, parent: Option<&str>)

If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an #NMSettingWired setting with a #NMSettingWired:mac-address property.

pub fn set_protocol(&self, protocol: Option<&str>)

Available on crate feature v1_42 only.

Specifies the VLAN protocol to use for encapsulation.

Supported values are: ‘802.1Q’, ‘802.1ad’. If not specified the default value is ‘802.1Q’.

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

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

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

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

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

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

Available on crate feature v1_42 only.

Trait Implementations

impl Clone for SettingVlan

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 SettingVlan

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

Formats the value using the given formatter.

impl Default for SettingVlan

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SettingVlan

type ParamSpec = ParamSpecObject

type SetValue = SettingVlan

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SettingVlan

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 SettingVlan

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 SettingVlan

type Parent = Setting

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

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 SettingVlan

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 SettingVlan

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SettingVlan

impl IsA<Setting> for SettingVlan