Struct PrivateSecret 

pub struct PrivateSecret { /* private fields */ }

A per-run shared secret. Never printed; compare with verify only.

Implementations

impl PrivateSecret

pub fn generate() -> Result<Self, SecretError>

A fresh secret from the OS random source.

pub fn from_hex(text: &str) -> Result<Self, SecretError>

Parse the text form (exactly SECRET_HEX_LEN lowercase hex digits; no surrounding whitespace).

pub fn expose(&self) -> &str

The text form, for putting in a frame or on a pipe. Do not log it.

pub fn verify(&self, presented: &str) -> bool

Constant-time check of a presented secret. The comparison always runs over the full fixed-length buffer, and a presented value of the wrong length fails without an early return, so neither content nor length-prefix match leaks through timing.

pub fn read_from(reader: &mut impl BufRead) -> Result<Self, SecretError>

Read the secret from the first line of reader, at most SECRET_HEX_LEN plus a line ending long. For the child’s stdin; the generic form exists for tests.

pub fn read_from_stdin() -> Result<Self, SecretError>

Read the secret from this process’s stdin. Call it once, first, before anything else reads stdin; later reads (see watch_stdin_eof) continue after the secret line.

Trait Implementations

impl Clone for PrivateSecret

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PrivateSecret

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

Formats the value using the given formatter.

impl Drop for PrivateSecret

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.