nm-rs 0.1.3

Rust bindings for the libnm library.
Documentation
// 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,SettingSecretFlags};
use glib::{prelude::*,signal::{connect_raw, SignalHandlerId},translate::*};
use std::{boxed::Box as Box_};

glib::wrapper! {
    /// CDMA-based Mobile Broadband Settings
    ///
    /// ## Properties
    ///
    ///
    /// #### `mtu`
    ///  If non-zero, only transmit packets of the specified size or smaller,
    /// breaking larger packets up into multiple frames.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `number`
    ///  The number to dial to establish the connection to the CDMA-based mobile
    /// broadband network, if any.  If not specified, the default number (#777)
    /// is used when required.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `password`
    ///  The password used to authenticate with the network, if required.  Many
    /// providers do not require a password, or accept any password.  But if a
    /// password is required, it is specified here.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `password-flags`
    ///  Flags indicating how to handle the #NMSettingCdma:password property.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `username`
    ///  The username used to authenticate with the network, if required.  Many
    /// providers do not require a username, or accept any username.  But if a
    /// username is required, it is specified here.
    ///
    /// 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 = "NMSettingCdma")]
    pub struct SettingCdma(Object<ffi::NMSettingCdma, ffi::NMSettingCdmaClass>) @extends Setting;

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

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

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

    ///
    /// # Returns
    ///
    /// the #NMSettingCdma:mtu property of the setting
    #[cfg(feature = "v1_8")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_8")))]
    #[doc(alias = "nm_setting_cdma_get_mtu")]
    #[doc(alias = "get_mtu")]
    pub fn mtu(&self) -> u32 {
        unsafe {
            ffi::nm_setting_cdma_get_mtu(self.to_glib_none().0)
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingCdma:number property of the setting
    #[doc(alias = "nm_setting_cdma_get_number")]
    #[doc(alias = "get_number")]
    pub fn number(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::nm_setting_cdma_get_number(self.to_glib_none().0))
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingCdma:password property of the setting
    #[doc(alias = "nm_setting_cdma_get_password")]
    #[doc(alias = "get_password")]
    pub fn password(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::nm_setting_cdma_get_password(self.to_glib_none().0))
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingSecretFlags pertaining to the #NMSettingCdma:password
    #[doc(alias = "nm_setting_cdma_get_password_flags")]
    #[doc(alias = "get_password_flags")]
    #[doc(alias = "password-flags")]
    pub fn password_flags(&self) -> SettingSecretFlags {
        unsafe {
            from_glib(ffi::nm_setting_cdma_get_password_flags(self.to_glib_none().0))
        }
    }

    ///
    /// # Returns
    ///
    /// the #NMSettingCdma:username property of the setting
    #[doc(alias = "nm_setting_cdma_get_username")]
    #[doc(alias = "get_username")]
    pub fn username(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::nm_setting_cdma_get_username(self.to_glib_none().0))
        }
    }

    /// If non-zero, only transmit packets of the specified size or smaller,
    /// breaking larger packets up into multiple frames.
    #[cfg(feature = "v1_8")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_8")))]
    pub fn set_mtu(&self, mtu: u32) {
        ObjectExt::set_property(self,"mtu", mtu)
    }

    /// The number to dial to establish the connection to the CDMA-based mobile
    /// broadband network, if any.  If not specified, the default number (#777)
    /// is used when required.
    pub fn set_number(&self, number: Option<&str>) {
        ObjectExt::set_property(self,"number", number)
    }

    /// The password used to authenticate with the network, if required.  Many
    /// providers do not require a password, or accept any password.  But if a
    /// password is required, it is specified here.
    pub fn set_password(&self, password: Option<&str>) {
        ObjectExt::set_property(self,"password", password)
    }

    /// Flags indicating how to handle the #NMSettingCdma:password property.
    #[doc(alias = "password-flags")]
    pub fn set_password_flags(&self, password_flags: SettingSecretFlags) {
        ObjectExt::set_property(self,"password-flags", password_flags)
    }

    /// The username used to authenticate with the network, if required.  Many
    /// providers do not require a username, or accept any username.  But if a
    /// username is required, it is specified here.
    pub fn set_username(&self, username: Option<&str>) {
        ObjectExt::set_property(self,"username", username)
    }

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

    #[doc(alias = "number")]
    pub fn connect_number_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_number_trampoline<F: Fn(&SettingCdma) + 'static>(this: *mut ffi::NMSettingCdma, _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::number".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_number_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[doc(alias = "password")]
    pub fn connect_password_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_password_trampoline<F: Fn(&SettingCdma) + 'static>(this: *mut ffi::NMSettingCdma, _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::password".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_password_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[doc(alias = "password-flags")]
    pub fn connect_password_flags_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_password_flags_trampoline<F: Fn(&SettingCdma) + 'static>(this: *mut ffi::NMSettingCdma, _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::password-flags".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_password_flags_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }

    #[doc(alias = "username")]
    pub fn connect_username_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_username_trampoline<F: Fn(&SettingCdma) + 'static>(this: *mut ffi::NMSettingCdma, _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::username".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(notify_username_trampoline::<F> as *const ())), Box_::into_raw(f))
        }
    }
}

impl Default for SettingCdma {
                     fn default() -> Self {
                         Self::new()
                     }
                 }

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

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

                            /// If non-zero, only transmit packets of the specified size or smaller,
                            /// breaking larger packets up into multiple frames.
                            #[cfg(feature = "v1_8")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_8")))]
    pub fn mtu(self, mtu: u32) -> Self {
                            Self { builder: self.builder.property("mtu", mtu), }
                        }

                            /// The number to dial to establish the connection to the CDMA-based mobile
                            /// broadband network, if any.  If not specified, the default number (#777)
                            /// is used when required.
                            pub fn number(self, number: impl Into<glib::GString>) -> Self {
                            Self { builder: self.builder.property("number", number.into()), }
                        }

                            /// The password used to authenticate with the network, if required.  Many
                            /// providers do not require a password, or accept any password.  But if a
                            /// password is required, it is specified here.
                            pub fn password(self, password: impl Into<glib::GString>) -> Self {
                            Self { builder: self.builder.property("password", password.into()), }
                        }

                            /// Flags indicating how to handle the #NMSettingCdma:password property.
                            pub fn password_flags(self, password_flags: SettingSecretFlags) -> Self {
                            Self { builder: self.builder.property("password-flags", password_flags), }
                        }

                            /// The username used to authenticate with the network, if required.  Many
                            /// providers do not require a username, or accept any username.  But if a
                            /// username is required, it is specified here.
                            pub fn username(self, username: impl Into<glib::GString>) -> Self {
                            Self { builder: self.builder.property("username", username.into()), }
                        }

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