logo
pub struct Reader<'a> { /* private fields */ }
Expand description

A filter that strips ASCII Armor from a stream of data.

Implementations

👎 Deprecated:

Use Reader::from_reader. new will be removed in version 2.0

Constructs a new filter for the given type of data.

This function is deprecated and will be removed in version 2.0. Please use Reader::from_reader.

Constructs a new Reader from the given io::Reader.

ASCII Armor, designed to protect OpenPGP data in transit, has been a source of problems if the armor structure is damaged. For example, copying data manually from one program to another might introduce or drop newlines.

By default, the reader operates in tolerant mode. It will ignore common formatting errors but the header and footer lines must be intact.

To select stricter mode, specify the kind argument for tolerant mode. In this mode only ASCII Armor blocks with the appropriate header are recognized.

There is also very tolerant mode that is appropriate when reading text that the user cut and pasted into a text area. This mode of operation is CPU intense, particularly on large text files.

Examples
use std::io::{self, Read};
use sequoia_openpgp as openpgp;
use openpgp::Message;
use openpgp::armor::{Reader, ReaderMode};
use openpgp::parse::Parse;

let data = "yxJiAAAAAABIZWxsbyB3b3JsZCE="; // base64 over literal data packet

let mut cursor = io::Cursor::new(&data);
let mut reader = Reader::from_reader(&mut cursor, ReaderMode::VeryTolerant);

let mut buf = Vec::new();
reader.read_to_end(&mut buf)?;

let message = Message::from_bytes(&buf)?;
assert_eq!(message.body().unwrap().body(),
           b"Hello world!");

Or, in strict mode:

use std::io::{self, Result, Read};
use sequoia_openpgp as openpgp;
use openpgp::armor::{Reader, ReaderMode, Kind};

let data =
    "-----BEGIN PGP ARMORED FILE-----

     SGVsbG8gd29ybGQh
     =s4Gu
     -----END PGP ARMORED FILE-----";

let mut cursor = io::Cursor::new(&data);
let mut reader = Reader::from_reader(&mut cursor, ReaderMode::Tolerant(Some(Kind::File)));

let mut content = String::new();
reader.read_to_string(&mut content)?;
assert_eq!(content, "Hello world!");
assert_eq!(reader.kind(), Some(Kind::File));

Creates a Reader from a file.

Creates a Reader from a buffer.

Returns the kind of data this reader is for.

Useful if the kind of data is not known in advance. If the header has not been encountered yet (try reading some data first!), this function returns None.

Returns the armored headers.

The tuples contain a key and a value.

Note: if a key occurs multiple times, then there are multiple entries in the vector with the same key; values with the same key are not combined.

Examples
use std::io::{self, Read};
use sequoia_openpgp as openpgp;
use openpgp::armor::{Reader, ReaderMode, Kind};

let data =
    "-----BEGIN PGP ARMORED FILE-----
     First: value
     Header: value

     SGVsbG8gd29ybGQh
     =s4Gu
     -----END PGP ARMORED FILE-----";

let mut cursor = io::Cursor::new(&data);
let mut reader = Reader::from_reader(&mut cursor, ReaderMode::Tolerant(Some(Kind::File)));

let mut content = String::new();
reader.read_to_string(&mut content)?;
assert_eq!(reader.headers()?,
   &[("First".into(), "value".into()),
     ("Header".into(), "value".into())]);

Trait Implementations

Returns a reference to the internal buffer. Read more

Ensures that the internal buffer has at least amount bytes of data, and returns it. Read more

Like BufferedReader::data, but returns an error if there is not at least amount bytes available. Read more

Consumes some of the data. Read more

A convenience function that combines BufferedReader::data and BufferedReader::consume. Read more

A convenience function that effectively combines BufferedReader::data_hard and BufferedReader::consume. Read more

Returns a mutable reference to the inner BufferedReader, if any. Read more

Returns a reference to the inner BufferedReader, if any.

Returns the underlying reader, if any. Read more

Sets the BufferedReader’s cookie and returns the old value.

Returns a reference to the BufferedReader’s cookie.

Returns a mutable reference to the BufferedReader’s cookie.

Returns all of the data until EOF. Like BufferedReader::data, this does not actually consume the data that is read. Read more

Checks whether the end of the stream is reached.

Checks whether this reader is consummated. Read more

A convenience function for reading a 16-bit unsigned integer in big endian format. Read more

A convenience function for reading a 32-bit unsigned integer in big endian format. Read more

Reads until either terminal is encountered or EOF. Read more

Discards the input until one of the bytes in terminals is encountered. Read more

Discards the input until one of the bytes in terminals is encountered. Read more

Like BufferedReader::data_consume_hard, but returns the data in a caller-owned buffer. Read more

Like BufferedReader::steal, but instead of stealing a fixed number of bytes, steals all of the data until the end of file. Read more

Like BufferedReader::steal_eof, but instead of returning the data, the data is discarded. Read more

Copies data to the given writer returning the copied amount. Read more

A helpful debugging aid to pretty print a Buffered Reader stack. Read more

Boxes the reader.

👎 Deprecated:

Use into_boxed

Boxes the reader.

Formats the value using the given formatter. Read more

Formats the value using the given formatter. Read more

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

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

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

Determines if this Reader has an efficient read_vectored implementation. Read more

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

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

Read the exact number of bytes required to fill buf. Read more

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

Pull some bytes from this source into the specified buffer. Read more

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

Read the exact number of bytes required to fill buf. Read more

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

Transforms this Read instance to an Iterator over its bytes. Read more

Creates an adapter which will chain this stream with another. Read more

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.