// 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::AsyncResult;
use crate::Cancellable;
use crate::SocketAddress;
use glib::object::IsA;
use glib::translate::*;
use std::boxed::Box as Box_;
use std::fmt;
use std::pin::Pin;
use std::ptr;

glib::wrapper! {
    /// [`SocketAddressEnumerator`][crate::SocketAddressEnumerator] is an enumerator type for [`SocketAddress`][crate::SocketAddress]
    /// instances. It is returned by enumeration functions such as
    /// [`SocketConnectableExt::enumerate()`][crate::prelude::SocketConnectableExt::enumerate()], which returns a [`SocketAddressEnumerator`][crate::SocketAddressEnumerator]
    /// to list each [`SocketAddress`][crate::SocketAddress] which could be used to connect to that
    /// [`SocketConnectable`][crate::SocketConnectable].
    ///
    /// Enumeration is typically a blocking operation, so the asynchronous methods
    /// [`SocketAddressEnumeratorExt::next_async()`][crate::prelude::SocketAddressEnumeratorExt::next_async()] and
    /// `g_socket_address_enumerator_next_finish()` should be used where possible.
    ///
    /// Each [`SocketAddressEnumerator`][crate::SocketAddressEnumerator] can only be enumerated once. Once
    /// [`SocketAddressEnumeratorExt::next()`][crate::prelude::SocketAddressEnumeratorExt::next()] has returned [`None`], further
    /// enumeration with that [`SocketAddressEnumerator`][crate::SocketAddressEnumerator] is not possible, and it can
    /// be unreffed.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// # Implements
    ///
    /// [`SocketAddressEnumeratorExt`][trait@crate::prelude::SocketAddressEnumeratorExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GSocketAddressEnumerator")]
    pub struct SocketAddressEnumerator(Object<ffi::GSocketAddressEnumerator, ffi::GSocketAddressEnumeratorClass>);

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

pub const NONE_SOCKET_ADDRESS_ENUMERATOR: Option<&SocketAddressEnumerator> = None;

/// Trait containing all [`struct@SocketAddressEnumerator`] methods.
///
/// # Implementors
///
/// [`SocketAddressEnumerator`][struct@crate::SocketAddressEnumerator]
pub trait SocketAddressEnumeratorExt: 'static {
    /// Retrieves the next [`SocketAddress`][crate::SocketAddress] from `self`. Note that this
    /// may block for some amount of time. (Eg, a [`NetworkAddress`][crate::NetworkAddress] may need
    /// to do a DNS lookup before it can return an address.) Use
    /// [`next_async()`][Self::next_async()] if you need to avoid
    /// blocking.
    ///
    /// If `self` is expected to yield addresses, but for some reason
    /// is unable to (eg, because of a DNS error), then the first call to
    /// [`next()`][Self::next()] will return an appropriate error
    /// in *`error`. However, if the first call to
    /// [`next()`][Self::next()] succeeds, then any further
    /// internal errors (other than `cancellable` being triggered) will be
    /// ignored.
    /// ## `cancellable`
    /// optional [`Cancellable`][crate::Cancellable] object, [`None`] to ignore.
    ///
    /// # Returns
    ///
    /// a [`SocketAddress`][crate::SocketAddress] (owned by the caller), or [`None`] on
    ///  error (in which case *`error` will be set) or if there are no
    ///  more addresses.
    #[doc(alias = "g_socket_address_enumerator_next")]
    fn next<P: IsA<Cancellable>>(
        &self,
        cancellable: Option<&P>,
    ) -> Result<SocketAddress, glib::Error>;

    /// Asynchronously retrieves the next [`SocketAddress`][crate::SocketAddress] from `self`
    /// and then calls `callback`, which must call
    /// `g_socket_address_enumerator_next_finish()` to get the result.
    ///
    /// It is an error to call this multiple times before the previous callback has finished.
    /// ## `cancellable`
    /// optional [`Cancellable`][crate::Cancellable] object, [`None`] to ignore.
    /// ## `callback`
    /// a `GAsyncReadyCallback` to call when the request
    ///  is satisfied
    #[doc(alias = "g_socket_address_enumerator_next_async")]
    fn next_async<
        P: IsA<Cancellable>,
        Q: FnOnce(Result<SocketAddress, glib::Error>) + Send + 'static,
    >(
        &self,
        cancellable: Option<&P>,
        callback: Q,
    );

    fn next_async_future(
        &self,
    ) -> Pin<Box_<dyn std::future::Future<Output = Result<SocketAddress, glib::Error>> + 'static>>;
}

impl<O: IsA<SocketAddressEnumerator>> SocketAddressEnumeratorExt for O {
    fn next<P: IsA<Cancellable>>(
        &self,
        cancellable: Option<&P>,
    ) -> Result<SocketAddress, glib::Error> {
        unsafe {
            let mut error = ptr::null_mut();
            let ret = ffi::g_socket_address_enumerator_next(
                self.as_ref().to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    fn next_async<
        P: IsA<Cancellable>,
        Q: FnOnce(Result<SocketAddress, glib::Error>) + Send + 'static,
    >(
        &self,
        cancellable: Option<&P>,
        callback: Q,
    ) {
        let user_data: Box_<Q> = Box_::new(callback);
        unsafe extern "C" fn next_async_trampoline<
            Q: FnOnce(Result<SocketAddress, glib::Error>) + Send + 'static,
        >(
            _source_object: *mut glib::gobject_ffi::GObject,
            res: *mut crate::ffi::GAsyncResult,
            user_data: glib::ffi::gpointer,
        ) {
            let mut error = ptr::null_mut();
            let ret = ffi::g_socket_address_enumerator_next_finish(
                _source_object as *mut _,
                res,
                &mut error,
            );
            let result = if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            };
            let callback: Box_<Q> = Box_::from_raw(user_data as *mut _);
            callback(result);
        }
        let callback = next_async_trampoline::<Q>;
        unsafe {
            ffi::g_socket_address_enumerator_next_async(
                self.as_ref().to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                Some(callback),
                Box_::into_raw(user_data) as *mut _,
            );
        }
    }

    fn next_async_future(
        &self,
    ) -> Pin<Box_<dyn std::future::Future<Output = Result<SocketAddress, glib::Error>> + 'static>>
    {
        Box_::pin(crate::GioFuture::new(
            self,
            move |obj, cancellable, send| {
                obj.next_async(Some(cancellable), move |res| {
                    send.resolve(res);
                });
            },
        ))
    }
}

impl fmt::Display for SocketAddressEnumerator {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("SocketAddressEnumerator")
    }
}