Struct PrivateKey 

pub struct PrivateKey(pub [u8; 32]);

An Ed25519 private key (raw 32-byte seed).

Zeroize

PrivateKey derives Zeroize and ZeroizeOnDrop: the 32 seed bytes are overwritten with zeroes when a value is dropped. from_string and from_slice zero their intermediate scratch buffers when they return. Unredacted::write_string is the encoding path that wraps its scratch buffers in Zeroizing and writes directly into a caller-provided buffer, avoiding any return-value move.

Debug emits PrivateKey([REDACTED]). To render the encoded strkey form, serialize via serde, or emit the raw seed bytes in any form, wrap the value in Unredacted — see Unredacted’s doc for the full list of paths that opt-in unlocks.

Tuple Fields

0: [u8; 32]

Implementations

impl PrivateKey

pub const ENCODED_LEN: usize

impl PrivateKey

pub fn from_payload(payload: &[u8]) -> Result<Self, DecodeError>

pub fn from_string(s: &str) -> Result<Self, DecodeError>

pub fn from_slice(s: &[u8]) -> Result<Self, DecodeError>

pub fn as_unredacted(&self) -> Unredacted<&Self>

Borrows this private key as an Unredacted wrapper so it can be rendered via Display or to_string, or serialized in its strkey string form.

Trait Implementations

impl Clone for PrivateKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateKey

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

Formats the value using the given formatter.

impl Drop for PrivateKey

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 PrivateKey

impl FromStr for PrivateKey

type Err = DecodeError

The associated error which can be returned from parsing.

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

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

impl Hash for PrivateKey

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 PrivateKey

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PrivateKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PrivateKey

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for PrivateKey

impl Zeroize for PrivateKey

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.