mirrors/rage
1
0
Fork 0
mirror of https://github.com/str4d/rage.git synced 2025-04-04 11:27:43 +03:00
Code Issues Projects Releases Packages Wiki Activity

age: Improve documentation of Callbacks

Browse source
This commit is contained in:
Jack Grigg 2024-08-27 02:43:14 +00:00
parent ae2434216d
commit f243d63c31
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
age/src/lib.rs
View file

@ -278,6 +278,9 @@ pub trait Callbacks: Clone + Send + Sync + 'static {
/// ///
/// This can be used to prompt the user to take some physical action, such as /// This can be used to prompt the user to take some physical action, such as
/// inserting a hardware key. /// inserting a hardware key.
///
/// No guarantee is provided that the user sees this message (for example, if there is
/// no UI for displaying messages).
fn display_message(&self, message: &str); fn display_message(&self, message: &str);
/// Requests that the user provides confirmation for some action. /// Requests that the user provides confirmation for some action.
@ -300,9 +303,19 @@ pub trait Callbacks: Clone + Send + Sync + 'static {
/// Requests non-private input from the user. /// Requests non-private input from the user.
/// ///
/// To request private inputs, use [`Callbacks::request_passphrase`]. /// To request private inputs, use [`Callbacks::request_passphrase`].
///
/// Returns:
/// - `Some(input)` with the user-provided input.
/// - `None` if no input could be requested from the user (for example, if there is no
/// UI for displaying messages or typing inputs).
fn request_public_string(&self, description: &str) -> Option<String>; fn request_public_string(&self, description: &str) -> Option<String>;
/// Requests a passphrase to decrypt a key. /// Requests a passphrase to decrypt a key.
///
/// Returns:
/// - `Some(passphrase)` with the user-provided passphrase.
/// - `None` if no passphrase could be requested from the user (for example, if there
/// is no UI for displaying messages or typing inputs).
fn request_passphrase(&self, description: &str) -> Option<SecretString>; fn request_passphrase(&self, description: &str) -> Option<SecretString>;
} }