Struct PresharedKey 

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

Preshared key.

Wrapper around [u8; 32].

Implements

• Implements Zeroize and ZeroizeOnDrop for clearing secrets from memory.
• Implements TryFrom<&str> or TryFrom<String> for importing key from Base64 format.
• Implements fmt::Display for exporting key in Wireguard’s format.
• Implements fmt::Debug.

Examples

// generate new preshared key:
let preshared_key = PresharedKey::random();

// import key:
let imported_key = PresharedKey::try_from("MA4zR0tvQpZ4CQ7gs/KcAVMNMGIFBtDcfpjBr+0GwHY=")?;

// export key via `fmt::Display` trait:
let exported_key = imported_key.to_string();

assert_eq!(exported_key, "MA4zR0tvQpZ4CQ7gs/KcAVMNMGIFBtDcfpjBr+0GwHY=".to_string());

Implementations

impl PresharedKey

pub fn random() -> Self

Generate random PresharedKey.

impl PresharedKey

pub fn to_bytes(&self) -> [u8; 32]

Convert PresharedKey into byte array.

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

Get PresharedKey as reference to bytes.

Trait Implementations

impl Clone for PresharedKey

fn clone(&self) -> PresharedKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PresharedKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PresharedKey

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PresharedKey

Export PresharedKey as base64 format for Wireguard.

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

Formats the value using the given formatter.

impl Drop for PresharedKey

fn drop(&mut self)

Executes the destructor for this type.

impl From<[u8; 32]> for PresharedKey

fn from(value: [u8; 32]) -> Self

Converts to this type from the input type.

impl PartialEq for PresharedKey

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

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for PresharedKey

type Error = WireguardError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for PresharedKey

type Error = WireguardError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Zeroize for PresharedKey

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 StructuralPartialEq for PresharedKey