Struct Secret

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

WireGuard preshared key.

Implementations

impl Secret

pub fn new(data: [u8; 32]) -> Self

Create new from existing data. Warning: this function does not check if the passed data is valid.

impl Secret

pub fn from_hex(data: &str) -> Result<Self, ParseError>

Parse key from hex.

pub fn to_hex(&self) -> String

Encode key as hex.

impl Secret

pub fn from_base64(data: &str) -> Result<Self, ParseError>

Parse key from base64.

pub fn from_base64_urlsafe(data: &str) -> Result<Self, ParseError>

Parse key from base64 with urlsafe encoding.

pub fn to_base64(&self) -> String

Encode key as base64.

pub fn to_base64_urlsafe(&self) -> String

Encode key as base64 with urlsafe encoding.

impl Secret

pub fn parse(data: &str) -> Result<Self, ParseError>

Try parsing from string.

impl Secret

pub fn generate() -> Self

Generate new random preshared key using the system randomness generator.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Secret

Returns a duplicate 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 = [u8; 32]

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<(), Error>

Formats the value using the given formatter.

impl FromStr for Secret

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(value: &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 Ord for Secret

fn cmp(&self, other: &Secret) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Secret

fn eq(&self, other: &Secret) -> 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 PartialOrd for Secret

fn partial_cmp(&self, other: &Secret) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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 TryFrom<&[u8]> for Secret

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(key: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Secret

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Zeroize for Secret

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Copy for Secret

impl Eq for Secret

impl StructuralPartialEq for Secret