[][src]Struct sequoia_openpgp::packet::Literal

pub struct Literal { /* fields omitted */ }

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.

Methods

impl Literal[src]

pub fn new(format: DataFormat) -> Literal[src]

Returns a new Literal packet.

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

Gets the Literal packet's body.

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

Sets the Literal packet's body to the provided byte string.

pub fn format(&self) -> DataFormat[src]

Gets the Literal packet's content disposition.

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

Sets the Literal packet's content disposition.

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

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_from_bytes(
    &mut self,
    filename: &[u8]
) -> Result<Option<Vec<u8>>>
[src]

Sets the literal packet's filename field from a byte sequence.

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 set_filename(&mut self, filename: &str) -> Result<Option<Vec<u8>>>[src]

Sets the literal packet's filename field from a UTF-8 encoded string.

This is a convenience function, since the field is actually a raw byte string. 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<&Tm>[src]

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(&mut self, timestamp: Option<Tm>) -> Option<Tm>[src]

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.

Trait Implementations

impl Serialize for Literal[src]

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

Exports a serialized version of the object to o. Read more

impl SerializeInto for Literal[src]

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

Serializes the packet to a vector.

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

Exports into the given buffer. Read more

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

Exports to a vector. Read more

impl<'a> Parse<'a, Literal> for Literal[src]

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

Reads from the given file. Read more

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

Reads from the given slice. Read more

impl From<Literal> for Packet[src]

impl Eq for Literal[src]

impl PartialEq<Literal> for Literal[src]

impl Clone for Literal[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Hash for Literal[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0
[src]

Feeds a slice of this type into the given [Hasher]. Read more

impl Debug for Literal[src]

impl Arbitrary for Literal[src]

fn shrink(&self) -> Box<dyn Iterator<Item = Self> + 'static>

Auto Trait Implementations

impl Send for Literal

impl Sync for Literal

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip for T where
    V: MultiLane<T>,