Struct vault_rs::Secret

pub struct Secret(pub String);

A wrapper around a String with custom implementation of Display and Debug to not leak secrets during logging.

Methods from Deref<Target = String>

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire String.

Examples

Basic usage:

let s = String::from("foo");

assert_eq!("foo", s.as_str());

pub fn capacity(&self) -> usize

Returns this String's capacity, in bytes.

Examples

Basic usage:

let s = String::with_capacity(10);

assert!(s.capacity() >= 10);

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice of this String's contents.

The inverse of this method is from_utf8.

Examples

Basic usage:

let s = String::from("hello");

assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());

pub fn len(&self) -> usize

Returns the length of this String, in bytes, not [char]s or graphemes. In other words, it may not be what a human considers the length of the string.

Examples

Basic usage:

let a = String::from("foo");
assert_eq!(a.len(), 3);

let fancy_f = String::from("ƒoo");
assert_eq!(fancy_f.len(), 4);
assert_eq!(fancy_f.chars().count(), 3);

pub fn is_empty(&self) -> bool

Returns true if this String has a length of zero, and false otherwise.

Examples

Basic usage:

let mut v = String::new();
assert!(v.is_empty());

v.push('a');
assert!(!v.is_empty());

Trait Implementations

impl AsRef<str> for Secret

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Secret

fn clone(&self) -> Secret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl Deref for Secret

type Target = String

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Secret

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Secret

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

Formats the value using the given formatter.

impl Eq for Secret

impl From<String> for Secret

fn from(s: String) -> Self

Performs the conversion.

impl PartialEq<Secret> for Secret

fn eq(&self, other: &Secret) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Secret) -> bool

This method tests for !=.

impl Serialize for Secret

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Secret

impl StructuralPartialEq for Secret