Struct Secret 

pub struct Secret(/* private fields */);

Available on crate feature alloc only.

A text field that holds a secret (a password, a token).

No Display, no Clone (a clone is a second copy to wipe), no way to take the String out: expose is the only way to read it, which makes every read easy to find in review. The bytes are wiped on drop with crypt-io’s volatile wipe; Debug prints Secret(..).

Examples

use form_net::Secret;

let s = Secret::from(String::from("hunter2"));
assert_eq!(s.expose(), "hunter2");
assert_eq!(format!("{s:?}"), "Secret(..)");

Implementations

impl Secret

pub fn expose(&self) -> &str

The secret text.

pub fn len(&self) -> usize

Its length in bytes.

pub fn is_empty(&self) -> bool

Whether it is empty.

Trait Implementations

impl Debug for Secret

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

Formats the value using the given formatter.

impl Drop for Secret

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.

impl From<String> for Secret

fn from(s: String) -> Secret

Converts to this type from the input type.

impl FromField for Secret

type Slot = Option<Secret>

What has arrived so far.

fn accept_text(slot: &mut Self::Slot, value: &str) -> Result<(), ValueError>

Takes one text value.

fn finish(slot: Self::Slot) -> Result<Self, ValueError>

The value, once every field has arrived.

fn accept_file( slot: &mut Self::Slot, file: FileValue<'_>, ) -> Result<(), ValueError>

Takes one file.