gio/auto/

inet_address.rs

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

use crate::{ffi, SocketFamily};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// `GInetAddress` represents an IPv4 or IPv6 internet address. Use
    /// [`ResolverExt::lookup_by_name()`][crate::prelude::ResolverExt::lookup_by_name()] or
    /// [`ResolverExt::lookup_by_name_async()`][crate::prelude::ResolverExt::lookup_by_name_async()] to look up the `GInetAddress` for
    /// a hostname. Use [`ResolverExt::lookup_by_address()`][crate::prelude::ResolverExt::lookup_by_address()] or
    /// [`ResolverExt::lookup_by_address_async()`][crate::prelude::ResolverExt::lookup_by_address_async()] to look up the hostname for a
    /// `GInetAddress`.
    ///
    /// To actually connect to a remote host, you will need a
    /// [`InetSocketAddress`][crate::InetSocketAddress] (which includes a `GInetAddress` as well as a
    /// port number).
    ///
    /// ## Properties
    ///
    ///
    /// #### `bytes`
    ///  The raw address data.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `family`
    ///  The address family (IPv4 or IPv6).
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `is-any`
    ///  Whether this is the "any" address for its family.
    /// See g_inet_address_get_is_any().
    ///
    /// Readable
    ///
    ///
    /// #### `is-link-local`
    ///  Whether this is a link-local address.
    /// See g_inet_address_get_is_link_local().
    ///
    /// Readable
    ///
    ///
    /// #### `is-loopback`
    ///  Whether this is the loopback address for its family.
    /// See g_inet_address_get_is_loopback().
    ///
    /// Readable
    ///
    ///
    /// #### `is-mc-global`
    ///  Whether this is a global multicast address.
    /// See g_inet_address_get_is_mc_global().
    ///
    /// Readable
    ///
    ///
    /// #### `is-mc-link-local`
    ///  Whether this is a link-local multicast address.
    /// See g_inet_address_get_is_mc_link_local().
    ///
    /// Readable
    ///
    ///
    /// #### `is-mc-node-local`
    ///  Whether this is a node-local multicast address.
    /// See g_inet_address_get_is_mc_node_local().
    ///
    /// Readable
    ///
    ///
    /// #### `is-mc-org-local`
    ///  Whether this is an organization-local multicast address.
    /// See g_inet_address_get_is_mc_org_local().
    ///
    /// Readable
    ///
    ///
    /// #### `is-mc-site-local`
    ///  Whether this is a site-local multicast address.
    /// See g_inet_address_get_is_mc_site_local().
    ///
    /// Readable
    ///
    ///
    /// #### `is-multicast`
    ///  Whether this is a multicast address.
    /// See g_inet_address_get_is_multicast().
    ///
    /// Readable
    ///
    ///
    /// #### `is-site-local`
    ///  Whether this is a site-local address.
    /// See g_inet_address_get_is_loopback().
    ///
    /// Readable
    ///
    /// # Implements
    ///
    /// [`InetAddressExt`][trait@crate::prelude::InetAddressExt], [`trait@glib::ObjectExt`], [`InetAddressExtManual`][trait@crate::prelude::InetAddressExtManual]
    #[doc(alias = "GInetAddress")]
    pub struct InetAddress(Object<ffi::GInetAddress, ffi::GInetAddressClass>);

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

impl InetAddress {
    pub const NONE: Option<&'static InetAddress> = None;

    /// Creates a #GInetAddress for the "any" address (unassigned/"don't
    /// care") for @family.
    /// ## `family`
    /// the address family
    ///
    /// # Returns
    ///
    /// a new #GInetAddress corresponding to the "any" address
    /// for @family.
    ///     Free the returned object with g_object_unref().
    #[doc(alias = "g_inet_address_new_any")]
    pub fn new_any(family: SocketFamily) -> InetAddress {
        unsafe { from_glib_full(ffi::g_inet_address_new_any(family.into_glib())) }
    }

    /// Parses @string as an IP address and creates a new #GInetAddress.
    /// ## `string`
    /// a string representation of an IP address
    ///
    /// # Returns
    ///
    /// a new #GInetAddress corresponding
    /// to @string, or [`None`] if @string could not be parsed.
    ///     Free the returned object with g_object_unref().
    #[doc(alias = "g_inet_address_new_from_string")]
    #[doc(alias = "new_from_string")]
    pub fn from_string(string: &str) -> Option<InetAddress> {
        unsafe { from_glib_full(ffi::g_inet_address_new_from_string(string.to_glib_none().0)) }
    }

    /// Creates a #GInetAddress for the loopback address for @family.
    /// ## `family`
    /// the address family
    ///
    /// # Returns
    ///
    /// a new #GInetAddress corresponding to the loopback address
    /// for @family.
    ///     Free the returned object with g_object_unref().
    #[doc(alias = "g_inet_address_new_loopback")]
    pub fn new_loopback(family: SocketFamily) -> InetAddress {
        unsafe { from_glib_full(ffi::g_inet_address_new_loopback(family.into_glib())) }
    }
}

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

unsafe impl Send for InetAddress {}
unsafe impl Sync for InetAddress {}

/// Trait containing all [`struct@InetAddress`] methods.
///
/// # Implementors
///
/// [`InetAddress`][struct@crate::InetAddress]
pub trait InetAddressExt: IsA<InetAddress> + 'static {
    #[doc(alias = "g_inet_address_equal")]
    fn equal(&self, other_address: &impl IsA<InetAddress>) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_equal(
                self.as_ref().to_glib_none().0,
                other_address.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets @self's family
    ///
    /// # Returns
    ///
    /// @self's family
    #[doc(alias = "g_inet_address_get_family")]
    #[doc(alias = "get_family")]
    fn family(&self) -> SocketFamily {
        unsafe {
            from_glib(ffi::g_inet_address_get_family(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tests whether @self is the "any" address for its family.
    ///
    /// # Returns
    ///
    /// [`true`] if @self is the "any" address for its family.
    #[doc(alias = "g_inet_address_get_is_any")]
    #[doc(alias = "get_is_any")]
    #[doc(alias = "is-any")]
    fn is_any(&self) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_get_is_any(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tests whether @self is a link-local address (that is, if it
    /// identifies a host on a local network that is not connected to the
    /// Internet).
    ///
    /// # Returns
    ///
    /// [`true`] if @self is a link-local address.
    #[doc(alias = "g_inet_address_get_is_link_local")]
    #[doc(alias = "get_is_link_local")]
    #[doc(alias = "is-link-local")]
    fn is_link_local(&self) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_get_is_link_local(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tests whether @self is the loopback address for its family.
    ///
    /// # Returns
    ///
    /// [`true`] if @self is the loopback address for its family.
    #[doc(alias = "g_inet_address_get_is_loopback")]
    #[doc(alias = "get_is_loopback")]
    #[doc(alias = "is-loopback")]
    fn is_loopback(&self) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_get_is_loopback(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tests whether @self is a global multicast address.
    ///
    /// # Returns
    ///
    /// [`true`] if @self is a global multicast address.
    #[doc(alias = "g_inet_address_get_is_mc_global")]
    #[doc(alias = "get_is_mc_global")]
    #[doc(alias = "is-mc-global")]
    fn is_mc_global(&self) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_get_is_mc_global(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tests whether @self is a link-local multicast address.
    ///
    /// # Returns
    ///
    /// [`true`] if @self is a link-local multicast address.
    #[doc(alias = "g_inet_address_get_is_mc_link_local")]
    #[doc(alias = "get_is_mc_link_local")]
    #[doc(alias = "is-mc-link-local")]
    fn is_mc_link_local(&self) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_get_is_mc_link_local(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tests whether @self is a node-local multicast address.
    ///
    /// # Returns
    ///
    /// [`true`] if @self is a node-local multicast address.
    #[doc(alias = "g_inet_address_get_is_mc_node_local")]
    #[doc(alias = "get_is_mc_node_local")]
    #[doc(alias = "is-mc-node-local")]
    fn is_mc_node_local(&self) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_get_is_mc_node_local(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tests whether @self is an organization-local multicast address.
    ///
    /// # Returns
    ///
    /// [`true`] if @self is an organization-local multicast address.
    #[doc(alias = "g_inet_address_get_is_mc_org_local")]
    #[doc(alias = "get_is_mc_org_local")]
    #[doc(alias = "is-mc-org-local")]
    fn is_mc_org_local(&self) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_get_is_mc_org_local(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tests whether @self is a site-local multicast address.
    ///
    /// # Returns
    ///
    /// [`true`] if @self is a site-local multicast address.
    #[doc(alias = "g_inet_address_get_is_mc_site_local")]
    #[doc(alias = "get_is_mc_site_local")]
    #[doc(alias = "is-mc-site-local")]
    fn is_mc_site_local(&self) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_get_is_mc_site_local(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tests whether @self is a multicast address.
    ///
    /// # Returns
    ///
    /// [`true`] if @self is a multicast address.
    #[doc(alias = "g_inet_address_get_is_multicast")]
    #[doc(alias = "get_is_multicast")]
    #[doc(alias = "is-multicast")]
    fn is_multicast(&self) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_get_is_multicast(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tests whether @self is a site-local address such as 10.0.0.1
    /// (that is, the address identifies a host on a local network that can
    /// not be reached directly from the Internet, but which may have
    /// outgoing Internet connectivity via a NAT or firewall).
    ///
    /// # Returns
    ///
    /// [`true`] if @self is a site-local address.
    #[doc(alias = "g_inet_address_get_is_site_local")]
    #[doc(alias = "get_is_site_local")]
    #[doc(alias = "is-site-local")]
    fn is_site_local(&self) -> bool {
        unsafe {
            from_glib(ffi::g_inet_address_get_is_site_local(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the size of the native raw binary address for @self. This
    /// is the size of the data that you get from g_inet_address_to_bytes().
    ///
    /// # Returns
    ///
    /// the number of bytes used for the native version of @self.
    #[doc(alias = "g_inet_address_get_native_size")]
    #[doc(alias = "get_native_size")]
    fn native_size(&self) -> usize {
        unsafe { ffi::g_inet_address_get_native_size(self.as_ref().to_glib_none().0) }
    }

    /// Converts @self to string form.
    ///
    /// # Returns
    ///
    /// a representation of @self as a string, which should be
    /// freed after use.
    #[doc(alias = "g_inet_address_to_string")]
    #[doc(alias = "to_string")]
    fn to_str(&self) -> glib::GString {
        unsafe {
            from_glib_full(ffi::g_inet_address_to_string(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    //fn bytes(&self) -> /*Unimplemented*/Basic: Pointer {
    //    ObjectExt::property(self.as_ref(), "bytes")
    //}

    #[doc(alias = "is-any")]
    fn connect_is_any_notify<F: Fn(&Self) + Send + Sync + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_any_trampoline<
            P: IsA<InetAddress>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GInetAddress,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(InetAddress::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-any".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_any_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-link-local")]
    fn connect_is_link_local_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_link_local_trampoline<
            P: IsA<InetAddress>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GInetAddress,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(InetAddress::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-link-local".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_link_local_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-loopback")]
    fn connect_is_loopback_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_loopback_trampoline<
            P: IsA<InetAddress>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GInetAddress,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(InetAddress::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-loopback".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_loopback_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-mc-global")]
    fn connect_is_mc_global_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_mc_global_trampoline<
            P: IsA<InetAddress>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GInetAddress,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(InetAddress::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-mc-global".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_mc_global_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-mc-link-local")]
    fn connect_is_mc_link_local_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_mc_link_local_trampoline<
            P: IsA<InetAddress>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GInetAddress,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(InetAddress::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-mc-link-local".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_mc_link_local_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-mc-node-local")]
    fn connect_is_mc_node_local_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_mc_node_local_trampoline<
            P: IsA<InetAddress>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GInetAddress,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(InetAddress::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-mc-node-local".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_mc_node_local_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-mc-org-local")]
    fn connect_is_mc_org_local_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_mc_org_local_trampoline<
            P: IsA<InetAddress>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GInetAddress,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(InetAddress::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-mc-org-local".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_mc_org_local_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-mc-site-local")]
    fn connect_is_mc_site_local_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_mc_site_local_trampoline<
            P: IsA<InetAddress>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GInetAddress,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(InetAddress::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-mc-site-local".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_mc_site_local_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-multicast")]
    fn connect_is_multicast_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_multicast_trampoline<
            P: IsA<InetAddress>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GInetAddress,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(InetAddress::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-multicast".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_multicast_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-site-local")]
    fn connect_is_site_local_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_site_local_trampoline<
            P: IsA<InetAddress>,
            F: Fn(&P) + Send + Sync + 'static,
        >(
            this: *mut ffi::GInetAddress,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(InetAddress::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-site-local".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_site_local_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<InetAddress>> InetAddressExt for O {}