Struct sequoia_openpgp::packet::prelude::CompressedData

pub struct CompressedData { /* private fields */ }

Holds a compressed data packet.

A compressed data packet is a container. See Section 5.6 of RFC 4880 for details.

When the parser encounters a compressed data packet with an unknown compress algorithm, it returns an Unknown packet instead of a CompressedData packet.

Implementations

impl CompressedData

pub fn new(algo: CompressionAlgorithm) -> Self

Returns a new CompressedData packet.

pub fn algo(&self) -> CompressionAlgorithm

Gets the compression algorithm.

pub fn set_algo(&mut self, algo: CompressionAlgorithm) -> CompressionAlgorithm

Sets the compression algorithm.

Methods from Deref<Target = Container>

pub fn children_ref(&self) -> Option<&[Packet]>

Returns a reference to this Packet’s children.

Returns None if the body is not structured.

pub fn children_mut(&mut self) -> Option<&mut Vec<Packet>>

Returns a mutable reference to this Packet’s children.

Returns None if the body is not structured.

pub fn descendants(&self) -> Option<Iter<'_>>

Returns an iterator over the packet’s descendants. The descendants are visited in depth-first order.

Returns None if the body is not structured.

pub fn children(&self) -> Option<Iter<'_, Packet>>

Returns an iterator over the packet’s immediate children.

Returns None if the body is not structured.

pub fn body(&self) -> &Body

Gets the packet’s body.

pub fn set_body(&mut self, body: Body) -> Body

Sets the packet’s body.

Trait Implementations

impl Any<CompressedData> for Packet

fn downcast(self) -> Result<CompressedData, Packet>

Attempts to downcast to T, returning the packet if it fails.

fn downcast_ref(&self) -> Option<&CompressedData>

Attempts to downcast to &T, returning None if it fails.

fn downcast_mut(&mut self) -> Option<&mut CompressedData>

Attempts to downcast to &mut T, returning None if it fails.

impl Clone for CompressedData

fn clone(&self) -> CompressedData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompressedData

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

Formats the value using the given formatter.

impl Deref for CompressedData

type Target = Container

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for CompressedData

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<CompressedData> for Packet

fn from(s: CompressedData) -> Self

Converts to this type from the input type.

impl Hash for CompressedData

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 IntoIterator for CompressedData

Implement IntoIterator so that cert::insert_packets(sig) just works.

type Item = CompressedData

The type of the elements being iterated over.

type IntoIter = Once<CompressedData>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Marshal for CompressedData

fn serialize(&self, o: &mut dyn Write) -> Result<()>

Writes a serialized version of the specified CompressedData packet to o.

This function works recursively: if the CompressedData packet contains any packets, they are also serialized.

fn export(&self, o: &mut dyn Write) -> Result<()>

Exports a serialized version of the object to o.

impl MarshalInto for CompressedData

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

The size of the serialized compressed data packet is tricky to predict. First, it depends on the data being compressed. Second, we emit partial body encoded data.

This function tries overestimates the length. However, it may happen that serialize_into() fails.

Errors

If serialization would fail, this function returns 0.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer.

fn to_vec(&self) -> Result<Vec<u8>>

Serializes the packet to a vector.

fn export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

fn export_to_vec(&self) -> Result<Vec<u8>>

Exports to a vector.

impl<'a> Parse<'a, CompressedData> for CompressedData

fn from_reader<R: 'a + Read + Send + Sync>(reader: R) -> Result<Self>

Reads from the given reader.

fn from_file<P: AsRef<Path>>(path: P) -> Result<T>

Reads from the given file.

fn from_bytes<D: AsRef<[u8]> + ?Sized + Send + Sync>(data: &'a D) -> Result<T>

Reads from the given slice.

impl PartialEq<CompressedData> for CompressedData

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

impl StructuralEq for CompressedData

impl StructuralPartialEq for CompressedData