Skip to main content

KeyPair

Struct KeyPair 

Source
pub struct KeyPair { /* private fields */ }
Expand description

A complete hybrid keypair: private seeds plus derived key objects.

Create one with KeyPair::generate or restore one from a previous KeyPair::to_secret_bytes export via KeyPair::from_secret_bytes.

Implementations§

Source§

impl KeyPair

Source

pub fn generate() -> Result<Self>

Generate a fresh keypair from operating-system randomness.

§Errors

Returns Error::RandomnessUnavailable if the OS RNG fails.

Source

pub fn public_keys(&self) -> &PublicKeyBundle

The public half of this keypair, for sharing with peers.

Source

pub fn to_secret_bytes(&self) -> Zeroizing<Vec<u8>>

Export the private seeds as a v2 secret-key bundle (QSK2).

The returned buffer is zeroized on drop, but the caller is responsible for protecting any copy written to storage.

Source

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

Restore a keypair from a KeyPair::to_secret_bytes export.

§Errors

Returns Error::InvalidKey on malformed input, and version/suite errors for artifacts from other format versions.

Trait Implementations§

Source§

impl Debug for KeyPair

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<KeyPair> for HybridCrypto

Source§

fn from(keypair: KeyPair) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.