Struct pinentry_rs::PinentryBuilder

pub struct PinentryBuilder { /* private fields */ }

Builder for pinentry execution

Implementations

impl PinentryBuilder

pub fn description(self, desc: String) -> Self

Set the descriptive text of the prompt

pub fn error_text(self, error_text: String) -> Self

Set the text that gets the displayed in case of error

pub fn exe(self, exe: String) -> Self

Override the path to the pinentry executable (by default just pinentry, looked up using PATH environment variable)

pub fn label_cancel(self, label: String) -> Self

Set the label of the ‘Cancel’ button

pub fn label_notok(self, label: String) -> Self

Set the label of the ‘Not OK’ button

pub fn label_ok(self, label: String) -> Self

Set the label of the ‘OK’ button

pub fn timeout(self, secs: u32) -> Self

Set timeout for prompt (in seconds)

pub fn window_title(self, title: String) -> Self

Set the window title of the prompt

pub fn confirm_yes_no(self) -> Result<bool>

Prompt for confirmation

The text for the confirmation should be set using .description()

pub fn pin(self, prompt: String) -> Result<SecStr>

Prompt for a PIN

pub fn show_message(self) -> Result<()>

Show a message

The text for the message should be set using .description()

Trait Implementations

impl Default for PinentryBuilder

fn default() -> Self

Returns the “default value” for a type.