Struct sequoia_openpgp::types::CompressionLevel

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

Compression level.

This value is used by the encoders to tune their compression strategy. The level is restricted to levels commonly used by compression libraries, 0 to 9, where 0 means no compression, 1 means fastest compression, 6 being a good default, and meaning 9 best compression.

Note that compression is dangerous when used naively.

To mitigate some of these issues messages should use padding.

Examples

Write a message using the given CompressionAlgorithm:

use sequoia_openpgp as openpgp;
use std::io::Write;
use openpgp::serialize::stream::{Message, Compressor, LiteralWriter};
use openpgp::serialize::stream::padding::Padder;
use openpgp::types::{CompressionAlgorithm, CompressionLevel};

let mut sink = Vec::new();
let message = Message::new(&mut sink);
let message = Compressor::new(message)
    .algo(CompressionAlgorithm::Zlib)
    .level(CompressionLevel::fastest())
    .build()?;

let message = Padder::new(message).build()?;

let mut message = LiteralWriter::new(message).build()?;
message.write_all(b"Hello world.")?;
message.finalize()?;

Implementations

impl CompressionLevel

pub fn new(level: u8) -> Result<CompressionLevel>

Creates a new compression level.

level must be in range 0..10, where 0 means no compression, 1 means fastest compression, 6 being a good default, and meaning 9 best compression.

pub fn none() -> CompressionLevel

No compression.

pub fn fastest() -> CompressionLevel

Fastest compression.

pub fn best() -> CompressionLevel

Best compression.

Trait Implementations

impl Clone for CompressionLevel

fn clone(&self) -> CompressionLevel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompressionLevel

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

Formats the value using the given formatter.

impl Default for CompressionLevel

fn default() -> Self

Returns the “default value” for a type.

impl From<CompressionLevel> for Compression

fn from(l: CompressionLevel) -> Self

Converts to this type from the input type.

impl From<CompressionLevel> for Compression

fn from(l: CompressionLevel) -> Self

Converts to this type from the input type.

impl Hash for CompressionLevel

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 CompressionLevel

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

Restrict a value to a certain interval.

impl PartialEq for CompressionLevel

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

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

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.

impl PartialOrd for CompressionLevel

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

impl Eq for CompressionLevel

impl StructuralPartialEq for CompressionLevel