Struct sequoia_openpgp::types::KeyServerPreferences

pub struct KeyServerPreferences(_);

Describes preferences regarding key servers.

Key server preferences are specified in Section 5.2.3.17 of RFC 4880 and Section 5.2.3.18 of RFC 4880bis.

The keyserver preferences are set by the user’s OpenPGP implementation to communicate them to any peers.

A note on equality

PartialEq compares the serialized form of the two key server preference sets. If you prefer to compare two key server preference sets for semantic equality, you should use KeyServerPreferences::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(None, Some("alice@example.org"))
    .generate()?;

match cert.with_policy(p, None)?.primary_userid()?.key_server_preferences() {
    Some(preferences) => {
        println!("Certificate holder's keyserver preferences:");
        assert!(preferences.no_modify());
    }
    None => {
        println!("Certificate Holder did not specify any key server preferences.");
    }
}

Implementations

impl KeyServerPreferences

pub fn new<B: AsRef<[u8]>>(bits: B) -> Self

Creates a new instance from bits.

pub fn empty() -> Self

Returns an empty key server preference set.

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 key server preference sets for semantic equality.

KeyServerPreferences’ implementation of PartialEq compares two key server preference sets for serialized equality. That is, the PartialEq implementation considers two key server preference 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::KeyServerPreferences;

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

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

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

Returns whether the specified keyserver preference flag is set.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::KeyServerPreferences;

// Keyserver Preferences flags 0 and 2.
let ksp = KeyServerPreferences::new(&[0x5]);

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

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

Sets the specified keyserver preference flag.

This also clears any padding (trailing NUL bytes).

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::KeyServerPreferences;

let ksp = KeyServerPreferences::empty().set(0).set(2);

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

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

Clears the specified keyserver preference flag.

This also clears any padding (trailing NUL bytes).

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::KeyServerPreferences;

let ksp = KeyServerPreferences::empty().set(0).set(2).clear(2);

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

pub fn no_modify(&self) -> bool

Returns whether the certificate’s owner requests that the certificate is not modified.

If this flag is set, the certificate’s owner requests that the certificate should only be changed by the owner and the key server’s operator.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::KeyServerPreferences;

let ksp = KeyServerPreferences::empty();
assert!(! ksp.no_modify());

pub fn set_no_modify(self) -> Self

Requests that the certificate is not modified.

See KeyServerPreferences::no_modify.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::KeyServerPreferences;

let ksp = KeyServerPreferences::empty().set_no_modify();
assert!(ksp.no_modify());

pub fn clear_no_modify(self) -> Self

Clears the request that the certificate is not modified.

See KeyServerPreferences::no_modify.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::KeyServerPreferences;

let ksp = KeyServerPreferences::new(&[0x80][..]);
assert!(ksp.no_modify());
let ksp = ksp.clear_no_modify();
assert!(! ksp.no_modify());

Trait Implementations

impl Clone for KeyServerPreferences

fn clone(&self) -> KeyServerPreferences

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyServerPreferences

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

Formats the value using the given formatter.

impl Hash for KeyServerPreferences

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for KeyServerPreferences

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<KeyServerPreferences> for KeyServerPreferences

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

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

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

This method tests for !=.

impl PartialOrd<KeyServerPreferences> for KeyServerPreferences

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for KeyServerPreferences

impl StructuralEq for KeyServerPreferences

impl StructuralPartialEq for KeyServerPreferences