Struct sequoia_openpgp::packet::aed::AED1

pub struct AED1 { /* private fields */ }

Holds an AEAD encrypted data packet.

An AEAD encrypted data packet holds encrypted data. The data contains additional OpenPGP packets. See Section 5.16 of RFC 4880bis for details.

An AED packet is not normally instantiated directly. In most cases, you’ll create one as a side-effect of encrypting a message using the streaming serializer, or parsing an encrypted message using the PacketParser.

This feature is experimental. It has not been standardized and we advise users to not emit AED packets.

A note on equality

An unprocessed (encrypted) AED packet is never considered equal to a processed (decrypted) one. Likewise, a processed (decrypted) packet is never considered equal to a structured (parsed) one.

Implementations

impl AED1

pub fn new(
    sym_algo: SymmetricAlgorithm,
    aead: AEADAlgorithm,
    chunk_size: u64,
    iv: Box<[u8]>
) -> Result<Self>

Creates a new AED1 object.

pub fn symmetric_algo(&self) -> SymmetricAlgorithm

Gets the symmetric algorithm.

pub fn set_symmetric_algo(
    &mut self,
    sym_algo: SymmetricAlgorithm
) -> SymmetricAlgorithm

Sets the symmetric algorithm.

pub fn aead(&self) -> AEADAlgorithm

Gets the AEAD algorithm.

pub fn set_aead(&mut self, aead: AEADAlgorithm) -> AEADAlgorithm

Sets the AEAD algorithm.

pub fn chunk_size(&self) -> u64

Gets the chunk size.

pub fn set_chunk_size(&mut self, chunk_size: u64) -> Result<()>

Sets the chunk size.

pub fn chunk_digest_size(&self) -> Result<u64>

Gets the size of a chunk with a digest.

pub fn iv(&self) -> &[u8]

Gets the initialization vector for the AEAD algorithm.

pub fn set_iv(&mut self, iv: Box<[u8]>) -> Box<[u8]>

Sets the initialization vector for the AEAD 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 Clone for AED1

fn clone(&self) -> AED1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AED1

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

Formats the value using the given formatter.

impl Deref for AED1

type Target = Container

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for AED1

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

Mutably dereferences the value.

impl From<AED1> for Packet

fn from(p: AED1) -> Self

Converts to this type from the input type.

impl From<AED1> for AED

fn from(p: AED1) -> Self

Converts to this type from the input type.

impl Hash for AED1

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 Marshal for AED1

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

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

Errors

Returns Error::InvalidOperation if this packet has children. To construct an encrypted message, use serialize::stream::Encryptor.

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

Exports a serialized version of the object to o.

impl MarshalInto for AED1

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

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 PartialEq<AED1> for AED1

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

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

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

This method tests for !=.

impl Eq for AED1

impl StructuralEq for AED1

impl StructuralPartialEq for AED1