Signify

libsignify_rs::signify

Struct Signify 

Source 
pub struct Signify {
Show 17 fields
    pub mode: Option<Mode>,
    pub comment: Option<String>,
    pub embed: bool,
    pub msg_file: Option<PathBuf>,
    pub nopass: bool,
    pub pubkey: Option<PathBuf>,
    pub quiet: bool,
    pub seckey: Option<PathBuf>,
    pub sig_file: Option<PathBuf>,
    pub gzip: bool,
    pub key_id: Option<i32>,
    pub args: Vec<PathBuf>,
    pub pubkey_file_handle: Option<File>,
    pub seckey_file_handle: Option<File>,
    pub msg_file_handle: Option<File>,
    pub sig_file_handle: Option<File>,
    pub tty_file_handle: Option<File>,

}
Expand description

Runtime configuration.

This struct holds all configuration options parsed from command-line arguments or set programmatically.

§Examples

use libsignify_rs::signify::{Signify, Mode};
use std::path::PathBuf;

let mut signify = Signify::default();
signify.mode = Some(Mode::Sign);
signify.seckey = Some(PathBuf::from("key.sec"));
signify.embed = true;

assert_eq!(signify.mode, Some(Mode::Sign));
assert!(signify.embed);

Fields§

§mode: Option<Mode>

Operation mode.

§comment: Option<String>

Comment for key generation.

§embed: bool

Embedding mode flag.

§msg_file: Option<PathBuf>

Message file path.

§nopass: bool

No password flag.

§pubkey: Option<PathBuf>

Public key path.

§quiet: bool

Quiet mode flag.

§seckey: Option<PathBuf>

Secret key path.

§sig_file: Option<PathBuf>

Signature file path.

§gzip: bool

Gzip mode flag.

§key_id: Option<i32>

Key ID for keyring lookup.

§args: Vec<PathBuf>

Positional arguments.

§pubkey_file_handle: Option<File>

Public key file handle.

§seckey_file_handle: Option<File>

Secret key file handle.

§msg_file_handle: Option<File>

Message file handle.

§sig_file_handle: Option<File>

Signature file handle.

§tty_file_handle: Option<File>

TTY file handle for password Prompt.

Implementations§

Source§

impl Signify

Source

pub fn execute(&mut self) -> Result<()>

Execute the requested operation based on configuration.

§Errors

Returns errors if the operation fails or arguments are missing.

Source

pub fn sandbox(&self) -> Result<()>

Sandbox the binary depending on the requested operation.

Call this before calling execute.

Source

pub fn validate(&self) -> Result<()>

Validate required arguments before preopen/sandbox.

Call this before calling preopen to catch missing arguments early.

Source

pub fn preopen(&mut self) -> Result<()>

Pre-open files before sandboxing.

Trait Implementations§

Source§

impl Debug for Signify

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Signify

Source§

fn default() -> Signify

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.