Struct sequoia_openpgp::types::Features

source ·
pub struct Features(/* private fields */);
Expand description

Describes the features supported by an OpenPGP implementation.

The feature flags are defined in Section 5.2.3.24 of RFC 4880, and Section 5.2.3.25 of RFC 4880bis.

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();

match cert.with_policy(p, None)?.primary_userid()?.features() {
    Some(features) => {
        println!("Certificate holder's supported features:");
        assert!(features.supports_seipdv1());
        assert!(!features.supports_aead());
    }
    None => {
        println!("Certificate Holder did not specify any features.");
    }
}

Implementations§

source§

impl Features

source

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.

source

pub fn empty() -> Self

Returns an empty feature set.

source

pub fn sequoia() -> Self

Returns a feature set describing Sequoia’s capabilities.

source

pub fn as_bitfield(&self) -> &Bitfield

Returns a reference to the underlying Bitfield.

source

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

Returns a mutable reference to the underlying Bitfield.

source

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));
source

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 2.
let f = Features::new(&[0x5]);

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

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(2);

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

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(2).clear(2);

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

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());
source

pub fn supports_mdc(&self) -> bool

👎Deprecated: Use supports_seipdv1.

Returns whether the MDC feature flag is set.

source

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());
source

pub fn set_mdc(self) -> Self

👎Deprecated: Use set_seipdv1.

Sets the MDC feature flag.

source

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());
source

pub fn clear_mdc(self) -> Self

👎Deprecated: Use clear_seipdv1.

Clears the MDC feature flag.

source

pub fn supports_aead(&self) -> bool

👎Deprecated

Returns whether the AEAD feature flag is set.

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

let f = Features::empty();

assert!(! f.supports_aead());
source

pub fn set_aead(self) -> Self

👎Deprecated

Sets the AEAD feature flag.

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

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

assert!(f.supports_aead());
source

pub fn clear_aead(self) -> Self

👎Deprecated

Clears the AEAD feature flag.

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

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

let f = f.clear_aead();
assert!(! f.supports_aead());

Trait Implementations§

source§

impl Clone for Features

source§

fn clone(&self) -> Features

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Features

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for Features

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Features

source§

fn cmp(&self, other: &Features) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Features

source§

fn eq(&self, other: &Features) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Features

source§

fn partial_cmp(&self, other: &Features) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Eq for Features

source§

impl StructuralPartialEq for Features

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> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

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

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.