[][src]Struct sequoia_openpgp::Message

pub struct Message { /* fields omitted */ }

A message.

An OpenPGP message is a structured sequence of OpenPGP packets. Basically, it's an optionally encrypted, optionally signed literal data packet. The exact structure is defined in Section 11.3 of RFC 4880.

Implementations

impl Message[src]

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

Returns the body of the message.

Returns None if no literal data packet is found. This happens if a SEIP container has not been decrypted.

Methods from Deref<Target = PacketPile>

pub fn pretty_print(&self)[src]

Pretty prints the message to stderr.

This function is primarily intended for debugging purposes.

pub fn path_ref(&self, pathspec: &[usize]) -> Option<&Packet>[src]

Returns a reference to the packet at the location described by pathspec.

pathspec is a slice of the form [ 0, 1, 2 ]. Each element is the index of packet in a container. Thus, the previous path specification means: return the third child of the second child of the first top-level packet. In other words, the starred packet in the following tree:

        PacketPile
       /     |     \
      0      1      2  ...
    /   \
   /     \
 0         1  ...
       /   |   \  ...
      0    1    2
                *

And, [ 10 ] means return the 11th top-level packet.

Note: there is no packet at the root. Thus, the path [] returns None.

pub fn descendants(&self) -> Iter[src]

Returns an iterator over all of the packet's descendants, in depth-first order.

pub fn children<'a>(&'a self) -> Iter<'a, Packet>[src]

Returns an iterator over the top-level packets.

Trait Implementations

impl Debug for Message[src]

impl Deref for Message[src]

type Target = PacketPile

The resulting type after dereferencing.

impl From<Message> for PacketPile[src]

impl FromStr for Message[src]

type Err = Error

The associated error which can be returned from parsing.

impl Marshal for Message[src]

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

Writes a serialized version of the specified Message to o.

impl MarshalInto for Message[src]

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

fn from_reader<R: 'a + Read>(reader: R) -> Result<Self>[src]

Reads a Message from the specified reader.

See Message::try_from for more details.

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

Reads a Message from the specified file.

See Message::try_from for more details.

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

Reads a Message from buf.

See Message::try_from for more details.

impl PartialEq<Message> for Message[src]

impl Serialize for Message[src]

impl SerializeInto for Message[src]

impl StructuralPartialEq for Message[src]

impl TryFrom<PacketPile> for Message[src]

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pile: PacketPile) -> Result<Self>[src]

Converts the PacketPile to a Message.

Converting a PacketPile to a Message doesn't change the packets; it asserts that the packet sequence is an optionally encrypted, optionally signed, optionally compressed literal data packet. The exact grammar is defined in Section 11.3 of RFC 4880.

Caveats: this function assumes that any still encrypted parts or still compressed parts are valid messages.

impl TryFrom<Vec<Packet>> for Message[src]

type Error = Error

The type returned in the event of a conversion error.

fn try_from(packets: Vec<Packet>) -> Result<Self>[src]

Converts the vector of Packets to a Message.

See Message::try_from for more details.

Auto Trait Implementations

impl RefUnwindSafe for Message

impl Send for Message

impl Sync for Message

impl Unpin for Message

impl UnwindSafe for Message

Blanket Implementations

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

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

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

impl<T> From<T> for T[src]

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

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

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> 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<V> for T where
    V: MultiLane<T>,