libsecret/auto/

prompt.rs

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

use crate::ffi;
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// A prompt in the Service
    ///
    /// A proxy object representing a prompt that the Secret Service will display
    /// to the user.
    ///
    /// Certain actions on the Secret Service require user prompting to complete,
    /// such as creating a collection, or unlocking a collection. When such a prompt
    /// is necessary, then a #SecretPrompt object is created by this library, and
    /// passed to the [`ServiceExt::prompt()`][crate::prelude::ServiceExt::prompt()] method. In this way it is handled
    /// automatically.
    ///
    /// In order to customize prompt handling, override the
    /// `vfunc::Service::prompt_async` and `vfunc::Service::prompt_finish` virtual
    /// methods of the [`Service`][crate::Service] class.
    ///
    /// # Implements
    ///
    /// [`PromptExt`][trait@crate::prelude::PromptExt], [`trait@gio::prelude::DBusProxyExt`], [`trait@gio::prelude::DBusInterfaceExt`], [`trait@gio::prelude::InitableExt`], [`PromptExtManual`][trait@crate::prelude::PromptExtManual]
    #[doc(alias = "SecretPrompt")]
    pub struct Prompt(Object<ffi::SecretPrompt, ffi::SecretPromptClass>) @extends gio::DBusProxy, @implements gio::DBusInterface, gio::Initable;

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

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

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::Prompt>> Sealed for T {}
}

/// Trait containing all [`struct@Prompt`] methods.
///
/// # Implementors
///
/// [`Prompt`][struct@crate::Prompt]
pub trait PromptExt: IsA<Prompt> + sealed::Sealed + 'static {
    /// Runs a prompt and performs the prompting.
    ///
    /// Returns a variant result if the prompt was completed and not dismissed. The
    /// type of result depends on the action the prompt is completing, and is defined
    /// in the Secret Service DBus API specification.
    ///
    /// If @window_id is non-null then it is used as an XWindow id on Linux. The API
    /// expects this id to be converted to a string using the ``d`` printf format. The
    /// Secret Service can make its prompt transient for the window with this id. In
    /// some Secret Service implementations this is not possible, so the behavior
    /// depending on this should degrade gracefully.
    ///
    /// This method may block indefinitely and should not be used in user interface
    /// threads.
    /// ## `window_id`
    /// string form of XWindow id for parent window to be transient for
    /// ## `cancellable`
    /// optional cancellation object
    /// ## `return_type`
    /// the variant type of the prompt result
    ///
    /// # Returns
    ///
    /// [`None`] if the prompt was dismissed or an error occurred
    #[doc(alias = "secret_prompt_perform_sync")]
    fn perform_sync(
        &self,
        window_id: Option<&str>,
        cancellable: Option<&impl IsA<gio::Cancellable>>,
        return_type: &glib::VariantTy,
    ) -> Result<glib::Variant, glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::secret_prompt_perform_sync(
                self.as_ref().to_glib_none().0,
                window_id.to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                return_type.to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }

    /// Runs a prompt and performs the prompting.
    ///
    /// Returns a variant result if the prompt was completed and not dismissed. The
    /// type of result depends on the action the prompt is completing, and is defined
    /// in the Secret Service DBus API specification.
    ///
    /// If @window_id is non-null then it is used as an XWindow id on Linux. The API
    /// expects this id to be converted to a string using the ``d`` printf format. The
    /// Secret Service can make its prompt transient for the window with this id. In
    /// some Secret Service implementations this is not possible, so the behavior
    /// depending on this should degrade gracefully.
    ///
    /// This runs the dialog in a recursive mainloop. When run from a user interface
    /// thread, this means the user interface will remain responsive. Care should be
    /// taken that appropriate user interface actions are disabled while running the
    /// prompt.
    /// ## `window_id`
    /// string form of XWindow id for parent window to be transient for
    /// ## `cancellable`
    /// optional cancellation object
    /// ## `return_type`
    /// the variant type of the prompt result
    ///
    /// # Returns
    ///
    /// [`None`] if the prompt was dismissed or an error occurred
    #[doc(alias = "secret_prompt_run")]
    fn run(
        &self,
        window_id: Option<&str>,
        cancellable: Option<&impl IsA<gio::Cancellable>>,
        return_type: &glib::VariantTy,
    ) -> Result<glib::Variant, glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let ret = ffi::secret_prompt_run(
                self.as_ref().to_glib_none().0,
                window_id.to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                return_type.to_glib_none().0,
                &mut error,
            );
            if error.is_null() {
                Ok(from_glib_full(ret))
            } else {
                Err(from_glib_full(error))
            }
        }
    }
}

impl<O: IsA<Prompt>> PromptExt for O {}