nm-rs 0.1.3

// 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::{ffi,Setting};
#[cfg(feature = "v1_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
use crate::{SettingTunMode};
use glib::{prelude::*};
#[cfg(feature = "v1_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
use glib::{signal::{connect_raw, SignalHandlerId},translate::*};
#[cfg(feature = "v1_2")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
use std::{boxed::Box as Box_};

glib::wrapper! {
    /// 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`][crate::SettingTunMode::Tun] to create a layer 3 device and
    /// [`SettingTunMode::Tap`][crate::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
    /// <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 = "NMSettingTun")]
    pub struct SettingTun(Object<ffi::NMSettingTun, ffi::NMSettingTunClass>) @extends Setting;

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

impl SettingTun {
    /// Creates a new #NMSettingTun object with default values.
    ///
    /// # Returns
    ///
    /// the new empty #NMSettingTun object
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "nm_setting_tun_new")]
    pub fn new() -> SettingTun {
        assert_initialized_main_thread!();
        unsafe {
            Setting::from_glib_full(ffi::nm_setting_tun_new()).unsafe_cast()
        }
    }

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

    ///
    /// # Returns
    ///
    /// the #NMSettingTun:group property of the setting
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "nm_setting_tun_get_group")]
    #[doc(alias = "get_group")]
    pub fn group(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::nm_setting_tun_get_group(self.to_glib_none().0))
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingTun:mode property of the setting
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "nm_setting_tun_get_mode")]
    #[doc(alias = "get_mode")]
    pub fn mode(&self) -> SettingTunMode {
        unsafe {
            from_glib(ffi::nm_setting_tun_get_mode(self.to_glib_none().0))
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingTun:multi-queue property of the setting
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "nm_setting_tun_get_multi_queue")]
    #[doc(alias = "get_multi_queue")]
    #[doc(alias = "multi-queue")]
    pub fn is_multi_queue(&self) -> bool {
        unsafe {
            from_glib(ffi::nm_setting_tun_get_multi_queue(self.to_glib_none().0))
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingTun:owner property of the setting
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "nm_setting_tun_get_owner")]
    #[doc(alias = "get_owner")]
    pub fn owner(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::nm_setting_tun_get_owner(self.to_glib_none().0))
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingTun:pi property of the setting
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "nm_setting_tun_get_pi")]
    #[doc(alias = "get_pi")]
    #[doc(alias = "pi")]
    pub fn is_pi(&self) -> bool {
        unsafe {
            from_glib(ffi::nm_setting_tun_get_pi(self.to_glib_none().0))
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingTun:vnet_hdr property of the setting
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "nm_setting_tun_get_vnet_hdr")]
    #[doc(alias = "get_vnet_hdr")]
    #[doc(alias = "vnet-hdr")]
    pub fn is_vnet_hdr(&self) -> bool {
        unsafe {
            from_glib(ffi::nm_setting_tun_get_vnet_hdr(self.to_glib_none().0))
        }
    }

    /// The group ID which will own the device. If set to [`None`] everyone
    /// will be able to use the device.
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn set_group(&self, group: Option<&str>) {
        ObjectExt::set_property(self,"group", group)
    }

    /// The operating mode of the virtual device. Allowed values are
    /// [`SettingTunMode::Tun`][crate::SettingTunMode::Tun] to create a layer 3 device and
    /// [`SettingTunMode::Tap`][crate::SettingTunMode::Tap] to create an Ethernet-like layer 2
    /// one.
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn set_mode(&self, mode: u32) {
        ObjectExt::set_property(self,"mode", mode)
    }

    /// 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.
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "multi-queue")]
    pub fn set_multi_queue(&self, multi_queue: bool) {
        ObjectExt::set_property(self,"multi-queue", multi_queue)
    }

    /// The user ID which will own the device. If set to [`None`] everyone
    /// will be able to use the device.
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn set_owner(&self, owner: Option<&str>) {
        ObjectExt::set_property(self,"owner", owner)
    }

    /// If [`true`] the interface will prepend a 4 byte header describing the
    /// physical interface to the packets.
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn set_pi(&self, pi: bool) {
        ObjectExt::set_property(self,"pi", pi)
    }

    /// If [`true`] the IFF_VNET_HDR the tunnel packets will include a virtio
    /// network header.
    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "vnet-hdr")]
    pub fn set_vnet_hdr(&self, vnet_hdr: bool) {
        ObjectExt::set_property(self,"vnet-hdr", vnet_hdr)
    }

    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "group")]
    pub fn connect_group_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_group_trampoline<F: Fn(&SettingTun) + 'static>(this: *mut ffi::NMSettingTun, _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::group".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_group_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "mode")]
    pub fn connect_mode_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_mode_trampoline<F: Fn(&SettingTun) + 'static>(this: *mut ffi::NMSettingTun, _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::mode".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_mode_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "multi-queue")]
    pub fn connect_multi_queue_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_multi_queue_trampoline<F: Fn(&SettingTun) + 'static>(this: *mut ffi::NMSettingTun, _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::multi-queue".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_multi_queue_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "owner")]
    pub fn connect_owner_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_owner_trampoline<F: Fn(&SettingTun) + 'static>(this: *mut ffi::NMSettingTun, _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::owner".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_owner_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "pi")]
    pub fn connect_pi_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_pi_trampoline<F: Fn(&SettingTun) + 'static>(this: *mut ffi::NMSettingTun, _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::pi".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_pi_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    #[doc(alias = "vnet-hdr")]
    pub fn connect_vnet_hdr_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_vnet_hdr_trampoline<F: Fn(&SettingTun) + 'static>(this: *mut ffi::NMSettingTun, _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::vnet-hdr".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_vnet_hdr_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }
}

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

// rustdoc-stripper-ignore-next
        /// A [builder-pattern] type to construct [`SettingTun`] 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 SettingTunBuilder {
            builder: glib::object::ObjectBuilder<'static, SettingTun>,
        }

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

                            /// The group ID which will own the device. If set to [`None`] everyone
                            /// will be able to use the device.
                            #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn group(self, group: impl Into<glib::GString>) -> Self {
                            Self { builder: self.builder.property("group", group.into()), }
                        }

                            /// The operating mode of the virtual device. Allowed values are
                            /// [`SettingTunMode::Tun`][crate::SettingTunMode::Tun] to create a layer 3 device and
                            /// [`SettingTunMode::Tap`][crate::SettingTunMode::Tap] to create an Ethernet-like layer 2
                            /// one.
                            #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn mode(self, mode: u32) -> Self {
                            Self { builder: self.builder.property("mode", mode), }
                        }

                            /// 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.
                            #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn multi_queue(self, multi_queue: bool) -> Self {
                            Self { builder: self.builder.property("multi-queue", multi_queue), }
                        }

                            /// The user ID which will own the device. If set to [`None`] everyone
                            /// will be able to use the device.
                            #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn owner(self, owner: impl Into<glib::GString>) -> Self {
                            Self { builder: self.builder.property("owner", owner.into()), }
                        }

                            /// If [`true`] the interface will prepend a 4 byte header describing the
                            /// physical interface to the packets.
                            #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn pi(self, pi: bool) -> Self {
                            Self { builder: self.builder.property("pi", pi), }
                        }

                            /// If [`true`] the IFF_VNET_HDR the tunnel packets will include a virtio
                            /// network header.
                            #[cfg(feature = "v1_2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_2")))]
    pub fn vnet_hdr(self, vnet_hdr: bool) -> Self {
                            Self { builder: self.builder.property("vnet-hdr", vnet_hdr), }
                        }

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