nm_rs/auto/

wifi_p2p_peer.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::{Connection, NM80211ApFlags, Object, ffi};
use glib::{
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    ///
    ///
    /// ## Properties
    ///
    ///
    /// #### `flags`
    ///  The flags of the P2P peer.
    ///
    /// Readable
    ///
    ///
    /// #### `hw-address`
    ///  The hardware address of the P2P peer.
    ///
    /// Readable
    ///
    ///
    /// #### `last-seen`
    ///  The timestamp (in CLOCK_BOOTTIME seconds) for the last time the
    /// P2P peer was found.  A value of -1 means the peer has never been seen.
    ///
    /// Readable
    ///
    ///
    /// #### `manufacturer`
    ///  The manufacturer of the P2P peer.
    ///
    /// Readable
    ///
    ///
    /// #### `model`
    ///  The model of the P2P peer.
    ///
    /// Readable
    ///
    ///
    /// #### `model-number`
    ///  The hardware address of the P2P peer.
    ///
    /// Readable
    ///
    ///
    /// #### `name`
    ///  The name of the P2P peer.
    ///
    /// Readable
    ///
    ///
    /// #### `serial`
    ///  The serial number of the P2P peer.
    ///
    /// Readable
    ///
    ///
    /// #### `strength`
    ///  The current signal strength of the P2P peer.
    ///
    /// Readable
    ///
    ///
    /// #### `wfd-ies`
    ///  The WFD information elements of the P2P peer.
    ///
    /// Readable
    /// <details><summary><h4>Object</h4></summary>
    ///
    ///
    /// #### `client`
    ///  The NMClient instance as returned by nm_object_get_client().
    ///
    /// When an NMObject gets removed from the NMClient cache,
    /// the NMObject:path property stays unchanged, but this client
    /// instance gets reset to [`None`]. You can use this property to
    /// track removal of the object from the cache.
    ///
    /// Readable
    ///
    ///
    /// #### `path`
    ///  The D-Bus object path.
    ///
    /// The D-Bus path of an object instance never changes, even if the object
    /// gets removed from the cache. To see whether the object is still in the
    /// cache, check NMObject:client.
    ///
    /// Readable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`ObjectExt`][trait@crate::prelude::ObjectExt]
    #[doc(alias = "NMWifiP2PPeer")]
    pub struct WifiP2PPeer(Object<ffi::NMWifiP2PPeer, ffi::NMWifiP2PPeerClass>) @extends Object;

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

impl WifiP2PPeer {
    /// Validates a given connection against a given Wi-Fi P2P peer to ensure that
    /// the connection may be activated with that peer. The connection must match the
    /// @self's address and in the future possibly other attributes.
    /// ## `connection`
    /// an #NMConnection to validate against @self
    ///
    /// # Returns
    ///
    /// [`true`] if the connection may be activated with this Wi-Fi P2P Peer,
    /// [`false`] if it cannot be.
    #[doc(alias = "nm_wifi_p2p_peer_connection_valid")]
    pub fn connection_valid(&self, connection: &impl IsA<Connection>) -> bool {
        unsafe {
            from_glib(ffi::nm_wifi_p2p_peer_connection_valid(
                self.to_glib_none().0,
                connection.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Filters a given array of connections for a given #NMWifiP2PPeer object and
    /// returns connections which may be activated with the P2P peer.  Any
    /// returned connections will match the @peers's HW address and in the future
    /// possibly other attributes.
    ///
    /// To obtain the list of connections that are compatible with this P2P peer,
    /// use nm_client_get_connections() and then filter the returned list for a given
    /// #NMDevice using nm_device_filter_connections() and finally filter that list
    /// with this function.
    /// ## `connections`
    /// an array of #NMConnections to
    /// filter
    ///
    /// # Returns
    ///
    /// an array of
    /// #NMConnections that could be activated with the given @self. The array should
    /// be freed with g_ptr_array_unref() when it is no longer required.
    #[doc(alias = "nm_wifi_p2p_peer_filter_connections")]
    pub fn filter_connections(&self, connections: &[Connection]) -> Vec<Connection> {
        unsafe {
            FromGlibPtrContainer::from_glib_container(ffi::nm_wifi_p2p_peer_filter_connections(
                self.to_glib_none().0,
                connections.to_glib_none().0,
            ))
        }
    }

    /// Gets the flags of the P2P peer.
    ///
    /// # Returns
    ///
    /// the flags
    #[doc(alias = "nm_wifi_p2p_peer_get_flags")]
    #[doc(alias = "get_flags")]
    pub fn flags(&self) -> NM80211ApFlags {
        unsafe { from_glib(ffi::nm_wifi_p2p_peer_get_flags(self.to_glib_none().0)) }
    }

    /// Gets the hardware address of the P2P peer.
    ///
    /// # Returns
    ///
    /// the hardware address
    #[doc(alias = "nm_wifi_p2p_peer_get_hw_address")]
    #[doc(alias = "get_hw_address")]
    #[doc(alias = "hw-address")]
    pub fn hw_address(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::nm_wifi_p2p_peer_get_hw_address(self.to_glib_none().0)) }
    }

    /// Returns the timestamp (in CLOCK_BOOTTIME seconds) for the last time the
    /// P2P peer was seen.  A value of -1 means the P2P peer has never been seen.
    ///
    /// # Returns
    ///
    /// the last seen time in seconds
    #[doc(alias = "nm_wifi_p2p_peer_get_last_seen")]
    #[doc(alias = "get_last_seen")]
    #[doc(alias = "last-seen")]
    pub fn last_seen(&self) -> i32 {
        unsafe { ffi::nm_wifi_p2p_peer_get_last_seen(self.to_glib_none().0) }
    }

    /// Gets the manufacturer of the P2P peer.
    ///
    /// # Returns
    ///
    /// the manufacturer
    #[doc(alias = "nm_wifi_p2p_peer_get_manufacturer")]
    #[doc(alias = "get_manufacturer")]
    pub fn manufacturer(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::nm_wifi_p2p_peer_get_manufacturer(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the model of the P2P peer.
    ///
    /// # Returns
    ///
    /// the model
    #[doc(alias = "nm_wifi_p2p_peer_get_model")]
    #[doc(alias = "get_model")]
    pub fn model(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::nm_wifi_p2p_peer_get_model(self.to_glib_none().0)) }
    }

    /// Gets the model number of the P2P peer.
    ///
    /// # Returns
    ///
    /// the model number
    #[doc(alias = "nm_wifi_p2p_peer_get_model_number")]
    #[doc(alias = "get_model_number")]
    #[doc(alias = "model-number")]
    pub fn model_number(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::nm_wifi_p2p_peer_get_model_number(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the name of the P2P peer.
    ///
    /// # Returns
    ///
    /// the name
    #[doc(alias = "nm_wifi_p2p_peer_get_name")]
    #[doc(alias = "get_name")]
    pub fn name(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::nm_wifi_p2p_peer_get_name(self.to_glib_none().0)) }
    }

    /// Gets the serial number of the P2P peer.
    ///
    /// # Returns
    ///
    /// the serial number
    #[doc(alias = "nm_wifi_p2p_peer_get_serial")]
    #[doc(alias = "get_serial")]
    pub fn serial(&self) -> glib::GString {
        unsafe { from_glib_none(ffi::nm_wifi_p2p_peer_get_serial(self.to_glib_none().0)) }
    }

    /// Gets the current signal strength of the P2P peer as a percentage.
    ///
    /// # Returns
    ///
    /// the signal strength (0 to 100)
    #[doc(alias = "nm_wifi_p2p_peer_get_strength")]
    #[doc(alias = "get_strength")]
    pub fn strength(&self) -> u8 {
        unsafe { ffi::nm_wifi_p2p_peer_get_strength(self.to_glib_none().0) }
    }

    //#[doc(alias = "nm_wifi_p2p_peer_get_wfd_ies")]
    //#[doc(alias = "get_wfd_ies")]
    //#[doc(alias = "wfd-ies")]
    //pub fn wfd_ies(&self) -> /*Ignored*/glib::Bytes {
    //    unsafe { TODO: call ffi:nm_wifi_p2p_peer_get_wfd_ies() }
    //}

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

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

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

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

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

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

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

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

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

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

impl std::fmt::Display for WifiP2PPeer {
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.write_str(&self.name())
    }
}