Struct PublicKey

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

A crypto_box public key.

This type can be serialized if the serde feature is enabled.

Implementations

impl PublicKey

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

Initialize PublicKey from a byte array.

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

Initialize PublicKey from a byte slice.

Returns TryFromSliceError if the slice length is not exactly equal to KEY_SIZE.

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

Borrow the public key as bytes.

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

Serialize this public key as bytes.

pub fn seal( &self, csprng: &mut impl CryptoRngCore, plaintext: &[u8], ) -> Result<Vec<u8>, Error>

Available on crate feature seal only.

Implementation of crypto_box_seal function from libsodium “sealed boxes”.

Sealed boxes are designed to anonymously send messages to a recipient given their public key.

Trait Implementations

impl AsRef<[u8]> for PublicKey

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

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

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublicKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PublicKey

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 From<&SecretKey> for PublicKey

fn from(secret_key: &SecretKey) -> PublicKey

Converts to this type from the input type.

impl From<[u8; 32]> for PublicKey

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

Converts to this type from the input type.

impl From<MontgomeryPoint> for PublicKey

fn from(value: MontgomeryPoint) -> Self

Converts to this type from the input type.

impl Hash for PublicKey

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 PublicKey

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.

impl PartialEq for PublicKey

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

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 Serialize for PublicKey

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<&[u8]> for PublicKey

type Error = TryFromSliceError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for PublicKey

impl StructuralPartialEq for PublicKey