Struct Secret

pub struct Secret<'s> { /* private fields */ }

Represents secrets.

Implementations

impl<'s> Secret<'s>

pub fn new(value: Cow<'s, [u8]>) -> Result<Self, Error>

Constructs Self, if possible.

Errors

Returns length::Error if the secret has an unsafe length.

pub const unsafe fn new_unchecked(value: Cow<'s, [u8]>) -> Self

Constructs Self without checking the secret length.

Safety

The caller must ensure that the secret length is safe.

pub fn borrowed(value: &'s [u8]) -> Result<Self, Error>

Constructs Self from borrowed data, if possible.

Errors

Returns length::Error if the secret has an unsafe length.

pub const unsafe fn borrowed_unchecked(value: &'s [u8]) -> Self

Constructs Self from borrowed data without checking the secret length.

Safety

The caller must ensure that the secret length is safe.

pub fn owned(value: Vec<u8>) -> Result<Self, Error>

Constructs Self from owned data, if possible.

Errors

Returns length::Error if the secret has an unsafe length.

pub const unsafe fn owned_unchecked(value: Vec<u8>) -> Self

Constructs Self from owned data without checking the secret length.

Safety

The caller must ensure that the secret length is safe.

pub fn get(self) -> Cow<'s, [u8]>

Consumes Self and returns the contained secret value.

impl Secret<'_>

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

Returns the secret value as bytes.

pub fn decode<S: AsRef<str>>(string: S) -> Result<Self, Error>

Decodes Self from the given string.

Errors

Returns Error if the secret could not be decoded. This can happen if the string is invalid or the resulting length is unsafe.

pub fn encode(&self) -> String

Encodes Self into String.

impl Secret<'_>

pub fn generate(length: Length) -> Self

Available on crate feature generate-secret only.

Generates secrets of the given length.

pub fn generate_default() -> Self

Available on crate feature generate-secret only.

Generates secrets of default length.

impl Secret<'_>

pub fn into_owned(self) -> Owned

Converts Self into Owned.

Trait Implementations

impl AsRef<[u8]> for Secret<'_>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'s> Clone for Secret<'s>

fn clone(&self) -> Secret<'s>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for Secret<'s>

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

Formats the value using the given formatter.

impl Default for Secret<'_>

Available on crate feature generate-secret only.

fn default() -> Self

Returns the “default value” for a type.

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

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Secret<'_>

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

Formats the value using the given formatter.

impl FromStr for Secret<'_>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Secret<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Secret<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Secret<'_>

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Secret<'_>