Trait age::Callbacks

pub trait Callbacks: Clone + Send + Sync + 'static {
    // Required methods
    fn display_message(&self, message: &str);
    fn confirm(
        &self,
        message: &str,
        yes_string: &str,
        no_string: Option<&str>
    ) -> Option<bool>;
    fn request_public_string(&self, description: &str) -> Option<String>;
    fn request_passphrase(&self, description: &str) -> Option<SecretString>;
}

Callbacks that might be triggered during encryption or decryption.

Structs that implement this trait should be given directly to the individual Recipient or Identity implementations that require them.

Required Methods

fn display_message(&self, message: &str)

Shows a message to the user.

This can be used to prompt the user to take some physical action, such as inserting a hardware key.

fn confirm( &self, message: &str, yes_string: &str, no_string: Option<&str> ) -> Option<bool>

Requests that the user provides confirmation for some action.

This can be used to, for example, request that a hardware key the plugin wants to try either be plugged in, or skipped.

• message is the request or call-to-action to be displayed to the user.
• yes_string and (optionally) no_string will be displayed on buttons or next to selection options in the user’s UI.

Returns:

• Some(true) if the user selected the option marked with yes_string.
• Some(false) if the user selected the option marked with no_string (or the default negative confirmation label).
• None if the confirmation request could not be given to the user (for example, if there is no UI for displaying messages).

fn request_public_string(&self, description: &str) -> Option<String>

Requests non-private input from the user.

To request private inputs, use Callbacks::request_passphrase.

fn request_passphrase(&self, description: &str) -> Option<SecretString>

Requests a passphrase to decrypt a key.

Object Safety

This trait is not object safe.

Implementors

impl Callbacks for UiCallbacks

Available on crate feature cli-common only.