Struct OpenPgpUserId

pub struct OpenPgpUserId(OpenPgpUserIdType);

A basic representation of a User ID for OpenPGP

While OpenPGP User IDs are loosely defined to be UTF-8 strings, they do not enforce particular rules around the use of e-mail addresses or their general length. This type allows to distinguish between plain UTF-8 strings and valid e-mail addresses. Valid e-mail addresses must provide a display part, use a top-level domain (TLD) and not rely on domain literals (e.g. IP address). The length of a User ID is implicitly limited by the maximum length of an OpenPGP packet (8192 bytes). As such, this type only allows a maximum length of 4096 bytes as middle ground.

Tuple Fields

0: OpenPgpUserIdType

Implementations

impl OpenPgpUserId

pub fn new(user_id: String) -> Result<Self, Error>

Creates a new OpenPgpUserId from a String

Errors

Returns an Error::Key if the chars of the provided String exceed 4096 bytes. This ensures to stay below the valid upper limit defined by the maximum OpenPGP packet size of 8192 bytes.

Examples

use std::str::FromStr;

use nethsm::OpenPgpUserId;

assert!(!OpenPgpUserId::new("🤡".to_string())?.is_email());

assert!(OpenPgpUserId::new("🤡 <foo@xn--rl8h.org>".to_string())?.is_email());

// an e-mail without a display name is not considered a valid e-mail
assert!(!OpenPgpUserId::new("<foo@xn--rl8h.org>".to_string())?.is_email());

// this fails because the provided String is too long
assert!(OpenPgpUserId::new("U".repeat(4097)).is_err());

pub fn is_email(&self) -> bool

Returns whether the OpenPgpUserId is a valid e-mail address

Examples

use nethsm::OpenPgpUserId;

assert!(!OpenPgpUserId::new("🤡".to_string())?.is_email());

assert!(OpenPgpUserId::new("🤡 <foo@xn--rl8h.org>".to_string())?.is_email());

Trait Implementations

impl AsRef<str> for OpenPgpUserId

fn as_ref(&self) -> &str

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

impl Clone for OpenPgpUserId

fn clone(&self) -> OpenPgpUserId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenPgpUserId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenPgpUserId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OpenPgpUserId

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

Formats the value using the given formatter.

impl From<OpenPgpUserId> for String

fn from(value: OpenPgpUserId) -> Self

Converts to this type from the input type.

impl FromStr for OpenPgpUserId

type Err = Error

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 OpenPgpUserId

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 PartialEq for OpenPgpUserId

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for OpenPgpUserId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for OpenPgpUserId

impl StructuralPartialEq for OpenPgpUserId