Struct SecretKey 

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

A secret key for asymmetric encryption using X25519

This key is used for decrypting messages and must be kept private. It is randomly generated and used to derive the corresponding public key.

Properties

• Size: 32 bytes (256 bits)
• Based on the X25519 elliptic curve
• Must be kept confidential
• Used to decrypt messages that were encrypted with the corresponding public key

Implementations

impl SecretKey

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Generate a new secret key from bytes

Arguments

• bytes - Byte slice of exactly SECRETKEYBYTES length

Returns

• Result<Self> - A new secret key or an error if the input is invalid

pub const fn from_bytes_exact(bytes: [u8; 32]) -> Self

Create a secret key from a fixed-size bytes

Arguments

• bytes - Byte array of exactly SECRETKEYBYTES length

Returns

• Self - A new secret key

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

Get a reference to the underlying bytes

Returns

• &[u8; SECRETKEYBYTES] - Reference to the secret key bytes

Trait Implementations

impl AsRef<[u8]> for SecretKey

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

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

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Display for SecretKey

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

Formats the value using the given formatter.

impl Drop for SecretKey

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 Eq for SecretKey

impl From<SecretKey> for [u8; 32]

fn from(key: SecretKey) -> [u8; 32]

Converts to this type from the input type.

impl From<[u8; 32]> for SecretKey

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

Converts to this type from the input type.

impl PartialEq for SecretKey

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

impl TryFrom<&[u8]> for SecretKey

type Error = SodiumError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Zeroize for SecretKey

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.