Struct CleartextSignatureReader 

pub struct CleartextSignatureReader<R: BufRead> { /* private fields */ }

A reader capable of extracting PGP cleartext signatures as defined by RFC 4880 Section 7.

https://datatracker.ietf.org/doc/html/rfc4880.html#section-7.

The source reader is expected to initially emit a '-----BEGIN PGP SIGNED MESSAGE----- line.

This type is effectively a filtering Read implementation. Given a source reader that will emit bytes constituting cleartext signature data, this reader will parse the special syntax defining the cleartext signature and store state in the instance. Only the original / signed cleartext bytes will be returned by read() calls.

Once EOF is reached, call Self::finalize() to consume the reader and return a CleartextSignatures holding parsed cleartext signature state.

Important: reading does not validate signatures. Use CleartextSignatures after parsing/reading to validate signatures.

Implementations

impl<R: BufRead> CleartextSignatureReader<R>

pub fn new(reader: R) -> Self

Construct a new instance from a reader.

pub fn finalize(self) -> CleartextSignatures

Finalize this reader, returning an object with signature state.

Trait Implementations

impl<R: BufRead> Read for CleartextSignatureReader<R>

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)

Read and return a fixed array of bytes from this source.