Skip to main content

PublicKey

Struct PublicKey 

Source
pub struct PublicKey(/* private fields */);
Expand description

A public key for asymmetric encryption using X25519

This key is used for encrypting messages and can be shared publicly. It is derived from the corresponding secret key using the X25519 elliptic curve.

§Properties

  • Size: 32 bytes (256 bits)
  • Based on the X25519 elliptic curve
  • Can be safely shared with anyone
  • Used to encrypt messages that can only be decrypted with the corresponding secret key

Implementations§

Source§

impl PublicKey

Source

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

Generate a new public key from bytes

§Arguments
  • bytes - Byte slice of exactly PUBLICKEYBYTES length
§Returns
  • Result<Self> - A new public key or an error if the input is invalid
Source

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

Create a public key from a fixed-size bytes

§Arguments
  • bytes - Byte array of exactly PUBLICKEYBYTES length
§Returns
  • Self - A new public key
Source

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

Get a reference to the underlying bytes

§Returns
  • &[u8; PUBLICKEYBYTES] - Reference to the public key bytes

Trait Implementations§

Source§

impl AsRef<[u8]> for PublicKey

Source§

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

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

impl Clone for PublicKey

Source§

fn clone(&self) -> PublicKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PublicKey

Source§

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

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

impl Display for PublicKey

Source§

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

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

impl Eq for PublicKey

Source§

impl From<PublicKey> for [u8; 32]

Source§

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

Converts to this type from the input type.
Source§

impl From<[u8; 32]> for PublicKey

Source§

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

Converts to this type from the input type.
Source§

impl PartialEq for PublicKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PublicKey

Source§

impl TryFrom<&[u8]> for PublicKey

Source§

type Error = SodiumError

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

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

Performs the conversion.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.