Struct sequoia_openpgp::packet::Literal

pub struct Literal { /* private fields */ }

Holds a literal packet.

A literal packet contains unstructured data. Since the size can be very large, it is advised to process messages containing such packets using a PacketParser or a PacketPileParser and process the data in a streaming manner rather than the using the PacketPile::from_file and related interfaces.

See Section 5.9 of RFC 4880 for details.

Implementations

impl Literal

pub fn new(format: DataFormat) -> Literal

Returns a new Literal packet.

pub fn format(&self) -> DataFormat

Gets the Literal packet’s content disposition.

pub fn set_format(&mut self, format: DataFormat) -> DataFormat

Sets the Literal packet’s content disposition.

pub fn filename(&self) -> Option<&[u8]>

Gets the literal packet’s filename.

Note: when a literal data packet is protected by a signature, only the literal data packet’s body is protected, not the meta-data. As such, this field should normally be ignored.

pub fn set_filename<F>(&mut self, filename: F) -> Result<Option<Vec<u8>>>

where F: AsRef<[u8]>,

Sets the literal packet’s filename field.

The standard does not specify the encoding. Filenames must not be longer than 255 bytes.

Note: when a literal data packet is protected by a signature, only the literal data packet’s body is protected, not the meta-data. As such, this field should not be used.

pub fn date(&self) -> Option<SystemTime>

Gets the literal packet’s date field.

Note: when a literal data packet is protected by a signature, only the literal data packet’s body is protected, not the meta-data. As such, this field should normally be ignored.

pub fn set_date<T>(&mut self, timestamp: T) -> Result<Option<SystemTime>>

where T: Into<Option<SystemTime>>,

Sets the literal packet’s date field.

Note: when a literal data packet is protected by a signature, only the literal data packet’s body is protected, not the meta-data. As such, this field should not be used.

impl Literal

This packet implements the unprocessed container interface.

Container packets like this one can contain unprocessed data.

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

Gets a reference to the this packet’s body.

pub fn set_body(&mut self, data: Vec<u8>) -> Vec<u8>

Sets the this packet’s body.

Trait Implementations

impl Any<Literal> for Packet

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

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

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

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

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

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

impl Clone for Literal

fn clone(&self) -> Literal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Literal

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

Formats the value using the given formatter.

impl Default for Literal

fn default() -> Self

Returns the “default value” for a type.

impl From<Literal> for Packet

fn from(s: Literal) -> Self

Converts to this type from the input type.

impl Hash for Literal

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 Literal

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

type Item = Literal

The type of the elements being iterated over.

type IntoIter = Once<Literal>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Marshal for Literal

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

Writes a serialized version of the object to o.

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

Exports a serialized version of the object to o.

impl MarshalInto for Literal

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<'a> Parse<'a, Literal> for Literal

fn from_buffered_reader<R>(reader: R) -> Result<Self>

where R: BufferedReader<Cookie> + 'a,

Reads from the given buffered reader.

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

Reads from the given reader.

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

Reads from the given slice.

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

Reads from the given file.

impl PartialEq for Literal

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

impl StructuralPartialEq for Literal