Skip to main content

PublicKey

Struct PublicKey 

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

A validated age public key.

PublicKey is a thin wrapper around a String that ensures the contained key starts with "age1". The validation is performed at construction time via new, which delegates to validate_age_prefix.

§Security

While this type guarantees the "age1" prefix, it does not perform full Bech32 decoding or curve validation. The actual cryptographic checks are left to the age crate when the key is used for encryption.

§Examples

use age_setup::PublicKey;

let pk = PublicKey::new("age1mykey".into())?;
println!("Public key: {}", pk);          // uses Display
println!("Exposed value: {}", pk.expose());

Implementations§

Source§

impl PublicKey

Source

pub fn new(raw: String) -> Result<Self>

Creates a new PublicKey after validating the raw string.

The string must be non‑empty and start with "age1" (case‑sensitive). Validation is performed by [validate_age_prefix].

§Errors

Returns Error::Validation if the key does not meet the prefix requirement.

§Examples
let valid = PublicKey::new("age1abcdef".into()).unwrap();
assert_eq!(valid.expose(), "age1abcdef");

let invalid = PublicKey::new("not-a-key".into());
assert!(invalid.is_err());
Source

pub fn expose(&self) -> &str

Returns the raw string representation of the public key.

The returned &str is safe to display, share, or use as an age recipient.

§Examples
let pk = PublicKey::new("age1test".into()).unwrap();
assert_eq!(pk.expose(), "age1test");

Trait Implementations§

Source§

impl AsRef<str> for PublicKey

Allows PublicKey to be used where a &str is expected.

fn print_key(key: &impl AsRef<str>) {
    println!("{}", key.as_ref());
}
let pk = PublicKey::new("age1foo".into()).unwrap();
print_key(&pk);
Source§

fn as_ref(&self) -> &str

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

The public key is printed in the format age1....

Source§

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

Formats the value using the given formatter. Read more

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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V