Enum Profile

#[non_exhaustive]
pub enum Profile {
    RFC9580,
    RFC4880,
}

Profiles select versions of the OpenPGP standard.

While this type implements Default, please consider what a good default for your use case is.

If you are doing a greenfield implementation where you know that every client understands RFC9580, you can just explicitly pick that.

Otherwise, you have to consider the state of the ecosystem your client will interact with. Maybe it is better to stick to generating RFC4880 certificates for the time being, while rolling out RFC9580 support. Consider adding a configuration option or command line switch like --profile, but pick a sensible default, and remember to don’t overwhelm your users.

For now, our default is RFC4880. This is a safe default for every downstream consumer that has existing legacy deployments (including their own previous versions using a legacy version of Sequoia). We will update this default once RFC9580 is more widely deployed.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

RFC9580

RFC9580, published in 2024, defines “v6” OpenPGP.

RFC4880

RFC4880, published in 2007, defines “v4” OpenPGP.

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Profile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl Default for Profile

fn default() -> Profile

Returns the “default value” for a type.

impl Hash for Profile

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 Profile

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

impl Eq for Profile

impl StructuralPartialEq for Profile