Struct Features

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

Describes the features supported by an OpenPGP implementation.

The feature flags are defined in Section 5.2.3.32 of RFC 9580, and Section 5.2.3.32 of draft-ietf-openpgp-crypto-refresh.

The feature flags are set by the user’s OpenPGP implementation to signal to any senders what features the implementation supports.

A note on equality

PartialEq compares the serialized form of the two feature sets. If you prefer to compare two feature sets for semantic equality, you should use Features::normalized_eq. The difference between semantic equality and serialized equality is that semantic equality ignores differences in the amount of padding.

Examples

use sequoia_openpgp as openpgp;
use openpgp::cert::prelude::*;
use openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

let (cert, _) =
    CertBuilder::general_purpose(Some("alice@example.org"))
    .generate()?;
match cert.with_policy(p, None)?.primary_userid()?.features() {
    Some(features) => {
        println!("Certificate holder's supported features:");
        assert!(features.supports_seipdv1());
        assert!(features.supports_seipdv2());
    }
    None => {
        println!("Certificate Holder did not specify any features.");
    }
}

Implementations

impl Features

pub fn new<B>(bytes: B) -> Self

where B: AsRef<[u8]>,

Creates a new instance from bytes.

This does not remove any trailing padding from bytes.

pub fn empty() -> Self

Returns an empty feature set.

pub fn sequoia() -> Self

Returns a feature set describing Sequoia’s capabilities.

pub fn as_bitfield(&self) -> &Bitfield

Returns a reference to the underlying Bitfield.

pub fn as_bitfield_mut(&mut self) -> &mut Bitfield

Returns a mutable reference to the underlying Bitfield.

pub fn normalized_eq(&self, other: &Self) -> bool

Compares two feature sets for semantic equality.

Features implementation of PartialEq compares two feature sets for serialized equality. That is, the PartialEq implementation considers two feature sets to not be equal if they have different amounts of padding. This comparison function ignores padding.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Features;

let a = Features::new(&[0x1]);
let b = Features::new(&[0x1, 0x0]);

assert!(a != b);
assert!(a.normalized_eq(&b));

pub fn get(&self, bit: usize) -> bool

Returns whether the specified feature flag is set.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Features;

// Feature flags 0 and 3.
let f = Features::new(&[0x9]);

assert!(f.get(0));
assert!(! f.get(1));
assert!(! f.get(2));
assert!(f.get(3));
assert!(! f.get(4));
assert!(! f.get(8));
assert!(! f.get(80));

pub fn set(self, bit: usize) -> Self

Sets the specified feature flag.

This also clears any padding (trailing NUL bytes).

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Features;

let f = Features::empty().set(0).set(3);

assert!(f.get(0));
assert!(! f.get(1));
assert!(! f.get(2));
assert!(f.get(3));
assert!(! f.get(4));
assert!(! f.get(8));
assert!(! f.get(80));

pub fn clear(self, bit: usize) -> Self

Clears the specified feature flag.

This also clears any padding (trailing NUL bytes).

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Features;

let f = Features::empty().set(0).set(3).clear(3);

assert!(f.get(0));
assert!(! f.get(1));
assert!(! f.get(2));
assert!(! f.get(3));

pub fn supports_seipdv1(&self) -> bool

Returns whether the SEIPDv1 feature flag is set.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Features;

let f = Features::empty();

assert!(! f.supports_seipdv1());

pub fn set_seipdv1(self) -> Self

Sets the SEIPDv1 feature flag.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Features;

let f = Features::empty().set_seipdv1();

assert!(f.supports_seipdv1());

pub fn clear_seipdv1(self) -> Self

Clears the SEIPDv1 feature flag.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Features;

let f = Features::new(&[0x1]);
assert!(f.supports_seipdv1());

let f = f.clear_seipdv1();
assert!(! f.supports_seipdv1());

pub fn supports_seipdv2(&self) -> bool

Returns whether the SEIPDv2 feature flag is set.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Features;

let f = Features::empty();

assert!(! f.supports_seipdv2());

pub fn set_seipdv2(self) -> Self

Sets the SEIPDv2 feature flag.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Features;

let f = Features::empty().set_seipdv2();

assert!(f.supports_seipdv2());

pub fn clear_seipdv2(self) -> Self

Clears the SEIPDv2 feature flag.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::Features;

let f = Features::new(&[0x8]);
assert!(f.supports_seipdv2());

let f = f.clear_seipdv2();
assert!(! f.supports_seipdv2());

Trait Implementations

impl Clone for Features

fn clone(&self) -> Features

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Features

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

Formats the value using the given formatter.

impl Hash for Features

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 Features

fn cmp(&self, other: &Features) -> 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 Features

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

fn partial_cmp(&self, other: &Features) -> 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 Eq for Features

impl StructuralPartialEq for Features