nm_rs/auto/

setting_tc_config.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir
// from gtk-girs (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{Setting, TCQdisc, TCTfilter, ffi};
use glib::{
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
    value::FromValue,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Linux Traffic Control Settings
    ///
    /// ## Properties
    ///
    ///
    /// #### `qdiscs`
    ///  Array of TC queueing disciplines.
    ///
    /// When the #NMSettingTCConfig setting is present, qdiscs from this
    /// property are applied upon activation. If the property is empty,
    /// all qdiscs are removed and the device will only
    /// have the default qdisc assigned by kernel according to the
    /// "net.core.default_qdisc" sysctl.
    ///
    /// If the #NMSettingTCConfig setting is not present, NetworkManager
    /// doesn't touch the qdiscs present on the interface.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `tfilters`
    ///  Array of TC traffic filters.
    ///
    /// When the #NMSettingTCConfig setting is present, filters from this
    /// property are applied upon activation. If the property is empty,
    /// NetworkManager removes all the filters.
    ///
    /// If the #NMSettingTCConfig setting is not present, NetworkManager
    /// doesn't touch the filters present on the interface.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>Setting</h4></summary>
    ///
    ///
    /// #### `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
    /// </details>
    ///
    /// # Implements
    ///
    /// [`SettingExt`][trait@crate::prelude::SettingExt]
    #[doc(alias = "NMSettingTCConfig")]
    pub struct SettingTCConfig(Object<ffi::NMSettingTCConfig, ffi::NMSettingTCConfigClass>) @extends Setting;

    match fn {
        type_ => || ffi::nm_setting_tc_config_get_type(),
    }
}

impl SettingTCConfig {
    /// Creates a new #NMSettingTCConfig object with default values.
    ///
    /// # Returns
    ///
    /// the new empty #NMSettingTCConfig object
    #[doc(alias = "nm_setting_tc_config_new")]
    pub fn new() -> SettingTCConfig {
        assert_initialized_main_thread!();
        unsafe { Setting::from_glib_full(ffi::nm_setting_tc_config_new()).unsafe_cast() }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`SettingTCConfig`] objects.
    ///
    /// This method returns an instance of [`SettingTCConfigBuilder`](crate::builders::SettingTCConfigBuilder) which can be used to create [`SettingTCConfig`] objects.
    pub fn builder() -> SettingTCConfigBuilder {
        SettingTCConfigBuilder::new()
    }

    /// Appends a new qdisc and associated information to the setting.  The
    /// given qdisc is duplicated internally and is not changed by this function.
    /// If an identical qdisc (considering attributes as well) already exists, the
    /// qdisc is not added and the function returns [`false`].
    /// ## `qdisc`
    /// the qdisc to add
    ///
    /// # Returns
    ///
    /// [`true`] if the qdisc was added; [`false`] if the qdisc was already known.
    #[doc(alias = "nm_setting_tc_config_add_qdisc")]
    pub fn add_qdisc(&self, qdisc: &TCQdisc) -> bool {
        unsafe {
            from_glib(ffi::nm_setting_tc_config_add_qdisc(
                self.to_glib_none().0,
                qdisc.to_glib_none().0,
            ))
        }
    }

    /// Appends a new tfilter and associated information to the setting.  The
    /// given tfilter is duplicated internally and is not changed by this function.
    /// If an identical tfilter (considering attributes as well) already exists, the
    /// tfilter is not added and the function returns [`false`].
    /// ## `tfilter`
    /// the tfilter to add
    ///
    /// # Returns
    ///
    /// [`true`] if the tfilter was added; [`false`] if the tfilter was already known.
    #[doc(alias = "nm_setting_tc_config_add_tfilter")]
    pub fn add_tfilter(&self, tfilter: &TCTfilter) -> bool {
        unsafe {
            from_glib(ffi::nm_setting_tc_config_add_tfilter(
                self.to_glib_none().0,
                tfilter.to_glib_none().0,
            ))
        }
    }

    /// Removes all configured queueing disciplines.
    #[doc(alias = "nm_setting_tc_config_clear_qdiscs")]
    pub fn clear_qdiscs(&self) {
        unsafe {
            ffi::nm_setting_tc_config_clear_qdiscs(self.to_glib_none().0);
        }
    }

    /// Removes all configured queueing disciplines.
    #[doc(alias = "nm_setting_tc_config_clear_tfilters")]
    pub fn clear_tfilters(&self) {
        unsafe {
            ffi::nm_setting_tc_config_clear_tfilters(self.to_glib_none().0);
        }
    }

    ///
    /// # Returns
    ///
    /// the number of configured queueing disciplines
    #[doc(alias = "nm_setting_tc_config_get_num_qdiscs")]
    #[doc(alias = "get_num_qdiscs")]
    pub fn num_qdiscs(&self) -> u32 {
        unsafe { ffi::nm_setting_tc_config_get_num_qdiscs(self.to_glib_none().0) }
    }

    ///
    /// # Returns
    ///
    /// the number of configured queueing disciplines
    #[doc(alias = "nm_setting_tc_config_get_num_tfilters")]
    #[doc(alias = "get_num_tfilters")]
    pub fn num_tfilters(&self) -> u32 {
        unsafe { ffi::nm_setting_tc_config_get_num_tfilters(self.to_glib_none().0) }
    }

    /// ## `idx`
    /// index number of the qdisc to return
    ///
    /// # Returns
    ///
    /// the qdisc at index @idx
    #[doc(alias = "nm_setting_tc_config_get_qdisc")]
    #[doc(alias = "get_qdisc")]
    pub fn qdisc(&self, idx: u32) -> TCQdisc {
        unsafe {
            from_glib_none(ffi::nm_setting_tc_config_get_qdisc(
                self.to_glib_none().0,
                idx,
            ))
        }
    }

    /// ## `idx`
    /// index number of the tfilter to return
    ///
    /// # Returns
    ///
    /// the tfilter at index @idx
    #[doc(alias = "nm_setting_tc_config_get_tfilter")]
    #[doc(alias = "get_tfilter")]
    pub fn tfilter(&self, idx: u32) -> TCTfilter {
        unsafe {
            from_glib_none(ffi::nm_setting_tc_config_get_tfilter(
                self.to_glib_none().0,
                idx,
            ))
        }
    }

    /// Removes the qdisc at index @idx.
    /// ## `idx`
    /// index number of the qdisc
    #[doc(alias = "nm_setting_tc_config_remove_qdisc")]
    pub fn remove_qdisc(&self, idx: u32) {
        unsafe {
            ffi::nm_setting_tc_config_remove_qdisc(self.to_glib_none().0, idx);
        }
    }

    /// Removes the first matching qdisc that matches @qdisc.
    /// ## `qdisc`
    /// the qdisc to remove
    ///
    /// # Returns
    ///
    /// [`true`] if the qdisc was found and removed; [`false`] if it was not.
    #[doc(alias = "nm_setting_tc_config_remove_qdisc_by_value")]
    pub fn remove_qdisc_by_value(&self, qdisc: &TCQdisc) -> bool {
        unsafe {
            from_glib(ffi::nm_setting_tc_config_remove_qdisc_by_value(
                self.to_glib_none().0,
                qdisc.to_glib_none().0,
            ))
        }
    }

    /// Removes the tfilter at index @idx.
    /// ## `idx`
    /// index number of the tfilter
    #[doc(alias = "nm_setting_tc_config_remove_tfilter")]
    pub fn remove_tfilter(&self, idx: u32) {
        unsafe {
            ffi::nm_setting_tc_config_remove_tfilter(self.to_glib_none().0, idx);
        }
    }

    /// Removes the first matching tfilter that matches @tfilter.
    /// ## `tfilter`
    /// the tfilter to remove
    ///
    /// # Returns
    ///
    /// [`true`] if the tfilter was found and removed; [`false`] if it was not.
    #[doc(alias = "nm_setting_tc_config_remove_tfilter_by_value")]
    pub fn remove_tfilter_by_value(&self, tfilter: &TCTfilter) -> bool {
        unsafe {
            from_glib(ffi::nm_setting_tc_config_remove_tfilter_by_value(
                self.to_glib_none().0,
                tfilter.to_glib_none().0,
            ))
        }
    }

    /// Array of TC queueing disciplines.
    ///
    /// When the #NMSettingTCConfig setting is present, qdiscs from this
    /// property are applied upon activation. If the property is empty,
    /// all qdiscs are removed and the device will only
    /// have the default qdisc assigned by kernel according to the
    /// "net.core.default_qdisc" sysctl.
    ///
    /// If the #NMSettingTCConfig setting is not present, NetworkManager
    /// doesn't touch the qdiscs present on the interface.
    pub fn qdiscs(&self) -> Vec<TCQdisc> {
        let vals = ObjectExt::property::<glib::ValueArray>(self, "qdiscs");
        vals.iter()
            .map(|value| unsafe { TCQdisc::from_value(value) })
            .collect()
    }

    /// Array of TC queueing disciplines.
    ///
    /// When the #NMSettingTCConfig setting is present, qdiscs from this
    /// property are applied upon activation. If the property is empty,
    /// all qdiscs are removed and the device will only
    /// have the default qdisc assigned by kernel according to the
    /// "net.core.default_qdisc" sysctl.
    ///
    /// If the #NMSettingTCConfig setting is not present, NetworkManager
    /// doesn't touch the qdiscs present on the interface.
    pub fn set_qdiscs(&self, qdiscs: &[&TCQdisc]) {
        ObjectExt::set_property(
            self,
            "qdiscs",
            qdiscs
                .iter()
                .map(|tcqdisc| tcqdisc.to_value())
                .collect::<glib::ValueArray>(),
        )
    }

    /// Array of TC traffic filters.
    ///
    /// When the #NMSettingTCConfig setting is present, filters from this
    /// property are applied upon activation. If the property is empty,
    /// NetworkManager removes all the filters.
    ///
    /// If the #NMSettingTCConfig setting is not present, NetworkManager
    /// doesn't touch the filters present on the interface.
    pub fn tfilters(&self) -> Vec<TCTfilter> {
        let vals = ObjectExt::property::<glib::ValueArray>(self, "tfilters");
        vals.iter()
            .map(|value| unsafe { TCTfilter::from_value(value) })
            .collect()
    }

    /// Array of TC traffic filters.
    ///
    /// When the #NMSettingTCConfig setting is present, filters from this
    /// property are applied upon activation. If the property is empty,
    /// NetworkManager removes all the filters.
    ///
    /// If the #NMSettingTCConfig setting is not present, NetworkManager
    /// doesn't touch the filters present on the interface.
    pub fn set_tfilters(&self, tfilters: &[&TCTfilter]) {
        ObjectExt::set_property(
            self,
            "tfilters",
            tfilters
                .iter()
                .map(|tctfilter| tctfilter.to_value())
                .collect::<glib::ValueArray>(),
        )
    }

    #[doc(alias = "qdiscs")]
    pub fn connect_qdiscs_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_qdiscs_trampoline<F: Fn(&SettingTCConfig) + 'static>(
            this: *mut ffi::NMSettingTCConfig,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::qdiscs".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_qdiscs_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "tfilters")]
    pub fn connect_tfilters_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_tfilters_trampoline<F: Fn(&SettingTCConfig) + 'static>(
            this: *mut ffi::NMSettingTCConfig,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::tfilters".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_tfilters_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

#[cfg(feature = "v1_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_12")))]
impl Default for SettingTCConfig {
    fn default() -> Self {
        Self::new()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`SettingTCConfig`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct SettingTCConfigBuilder {
    builder: glib::object::ObjectBuilder<'static, SettingTCConfig>,
}

impl SettingTCConfigBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// Array of TC queueing disciplines.
    ///
    /// When the #NMSettingTCConfig setting is present, qdiscs from this
    /// property are applied upon activation. If the property is empty,
    /// all qdiscs are removed and the device will only
    /// have the default qdisc assigned by kernel according to the
    /// "net.core.default_qdisc" sysctl.
    ///
    /// If the #NMSettingTCConfig setting is not present, NetworkManager
    /// doesn't touch the qdiscs present on the interface.
    pub fn qdiscs(self, qdiscs: &[&TCQdisc]) -> Self {
        Self {
            builder: self.builder.property(
                "qdiscs",
                qdiscs
                    .iter()
                    .map(|tcqdisc| tcqdisc.to_value())
                    .collect::<glib::ValueArray>(),
            ),
        }
    }

    /// Array of TC traffic filters.
    ///
    /// When the #NMSettingTCConfig setting is present, filters from this
    /// property are applied upon activation. If the property is empty,
    /// NetworkManager removes all the filters.
    ///
    /// If the #NMSettingTCConfig setting is not present, NetworkManager
    /// doesn't touch the filters present on the interface.
    pub fn tfilters(self, tfilters: &[&TCTfilter]) -> Self {
        Self {
            builder: self.builder.property(
                "tfilters",
                tfilters
                    .iter()
                    .map(|tctfilter| tctfilter.to_value())
                    .collect::<glib::ValueArray>(),
            ),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`SettingTCConfig`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> SettingTCConfig {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}