Enum CompressionAlgorithm

#[non_exhaustive]
pub enum CompressionAlgorithm {
    Uncompressed,
    Zip,
    Zlib,
    BZip2,
    Private(u8),
    Unknown(u8),
}

The OpenPGP compression algorithms as defined in Section 9.4 of RFC 9580.

Examples

Use CompressionAlgorithm to set the preferred compressions algorithms on a signature:

use sequoia_openpgp as openpgp;
use openpgp::packet::signature::SignatureBuilder;
use openpgp::types::{HashAlgorithm, CompressionAlgorithm, SignatureType};

let mut builder = SignatureBuilder::new(SignatureType::DirectKey)
    .set_hash_algo(HashAlgorithm::SHA512)
    .set_preferred_compression_algorithms(vec![
        CompressionAlgorithm::Zlib,
        CompressionAlgorithm::BZip2,
    ])?;

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.

Uncompressed

Null compression.

Zip

DEFLATE Compressed Data.

See RFC 1951 for details. Section 9.4 of RFC 9580 recommends that this algorithm should be implemented.

Zlib

ZLIB Compressed Data.

See RFC 1950 for details.

BZip2

bzip2

Private(u8)

Private compression algorithm identifier.

Unknown(u8)

Unknown compression algorithm identifier.

Implementations

impl CompressionAlgorithm

pub fn is_supported(&self) -> bool

Returns whether this algorithm is supported.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::CompressionAlgorithm;

assert!(CompressionAlgorithm::Uncompressed.is_supported());

assert!(!CompressionAlgorithm::Private(101).is_supported());

pub fn variants() -> impl Iterator<Item = Self>

Returns an iterator over all valid variants.

Returns an iterator over all known variants. This does not include the CompressionAlgorithm::Private, or CompressionAlgorithm::Unknown variants.

Trait Implementations

impl Clone for CompressionAlgorithm

fn clone(&self) -> CompressionAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompressionAlgorithm

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

Formats the value using the given formatter.

impl Default for CompressionAlgorithm

fn default() -> Self

Returns the “default value” for a type.

impl Display for CompressionAlgorithm

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

Formats the value using the given formatter.

impl From<CompressionAlgorithm> for u8

fn from(c: CompressionAlgorithm) -> u8

Converts to this type from the input type.

impl From<u8> for CompressionAlgorithm

fn from(u: u8) -> Self

Converts to this type from the input type.

impl Hash for CompressionAlgorithm

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 CompressionAlgorithm

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

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

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

impl Eq for CompressionAlgorithm

impl StructuralPartialEq for CompressionAlgorithm