Struct sequoia_openpgp::armor::Reader [−][src]
pub struct Reader<'a> { /* fields omitted */ }
A filter that strips ASCII Armor from a stream of data.
Implementations
impl<'a> Reader<'a>
[src]
impl<'a> Reader<'a>
[src]pub fn new<R, M>(inner: R, mode: M) -> Self where
R: 'a + Read + Send + Sync,
M: Into<Option<ReaderMode>>,
[src]
pub fn new<R, M>(inner: R, mode: M) -> Self where
R: 'a + Read + Send + Sync,
M: Into<Option<ReaderMode>>,
[src]Constructs a new filter for the given type of data.
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 robust mode. It will extract the first armored OpenPGP data block it can find, even if the armor frame is damaged, or missing.
To select strict mode, specify a kind argument. In strict mode, the reader will match on the armor frame. The reader ignores any data in front of the Armor Header Line, as long as the line the header is only prefixed by whitespace.
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::new(&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::new(&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));
pub fn from_reader<R, M>(reader: R, mode: M) -> Self where
R: 'a + Read + Send + Sync,
M: Into<Option<ReaderMode>>,
[src]
pub fn from_reader<R, M>(reader: R, mode: M) -> Self where
R: 'a + Read + Send + Sync,
M: Into<Option<ReaderMode>>,
[src]Creates a Reader
from an io::Read
er.
pub fn from_file<P, M>(path: P, mode: M) -> Result<Self> where
P: AsRef<Path>,
M: Into<Option<ReaderMode>>,
[src]
pub fn from_file<P, M>(path: P, mode: M) -> Result<Self> where
P: AsRef<Path>,
M: Into<Option<ReaderMode>>,
[src]Creates a Reader
from a file.
pub fn from_bytes<M>(bytes: &'a [u8], mode: M) -> Self where
M: Into<Option<ReaderMode>>,
[src]
pub fn from_bytes<M>(bytes: &'a [u8], mode: M) -> Self where
M: Into<Option<ReaderMode>>,
[src]Creates a Reader
from a buffer.
pub fn kind(&self) -> Option<Kind>
[src]
pub fn kind(&self) -> Option<Kind>
[src]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.
pub fn headers(&mut self) -> Result<&[(String, String)]>
[src]
pub fn headers(&mut self) -> Result<&[(String, String)]>
[src]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::new(&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
impl BufferedReader<Cookie> for Reader<'_>
[src]
impl BufferedReader<Cookie> for Reader<'_>
[src]fn data(&mut self, amount: usize) -> Result<&[u8]>
[src]
fn data(&mut self, amount: usize) -> Result<&[u8]>
[src]Ensures that the internal buffer has at least amount
bytes
of data, and returns it. Read more
fn data_hard(&mut self, amount: usize) -> Result<&[u8]>
[src]
fn data_hard(&mut self, amount: usize) -> Result<&[u8]>
[src]Like data()
, but returns an error if there is not at least
amount
bytes available. Read more
fn data_consume(&mut self, amount: usize) -> Result<&[u8]>
[src]
fn data_consume(&mut self, amount: usize) -> Result<&[u8]>
[src]A convenience function that combines data()
and consume()
. Read more
fn data_consume_hard(&mut self, amount: usize) -> Result<&[u8]>
[src]
fn data_consume_hard(&mut self, amount: usize) -> Result<&[u8]>
[src]A convenience function that effectively combines data_hard()
and consume()
. Read more
fn get_mut(&mut self) -> Option<&mut dyn BufferedReader<Cookie>>
[src]
fn get_mut(&mut self) -> Option<&mut dyn BufferedReader<Cookie>>
[src]Returns a mutable reference to the inner BufferedReader
, if
any. Read more
fn get_ref(&self) -> Option<&dyn BufferedReader<Cookie>>
[src]
fn get_ref(&self) -> Option<&dyn BufferedReader<Cookie>>
[src]Returns a reference to the inner BufferedReader
, if any.
fn into_inner<'b>(
self: Box<Self>
) -> Option<Box<dyn BufferedReader<Cookie> + 'b>> where
Self: 'b,
[src]
fn into_inner<'b>(
self: Box<Self>
) -> Option<Box<dyn BufferedReader<Cookie> + 'b>> where
Self: 'b,
[src]Returns the underlying reader, if any. Read more
fn cookie_set(&mut self, cookie: Cookie) -> Cookie
[src]
fn cookie_set(&mut self, cookie: Cookie) -> Cookie
[src]Sets the BufferedReader
’s cookie and returns the old value.
fn cookie_ref(&self) -> &Cookie
[src]
fn cookie_ref(&self) -> &Cookie
[src]Returns a reference to the BufferedReader
’s cookie.
fn cookie_mut(&mut self) -> &mut Cookie
[src]
fn cookie_mut(&mut self) -> &mut Cookie
[src]Returns a mutable reference to the BufferedReader
’s cookie.
fn data_eof(&mut self) -> Result<&[u8], Error>
[src]
fn data_eof(&mut self) -> Result<&[u8], Error>
[src]Returns all of the data until EOF. Like data()
, this does not
actually consume the data that is read. Read more
fn consummated(&mut self) -> bool
[src]
fn consummated(&mut self) -> bool
[src]Checks whether this reader is consummated. Read more
fn read_be_u16(&mut self) -> Result<u16, Error>
[src]
fn read_be_u16(&mut self) -> Result<u16, Error>
[src]A convenience function for reading a 16-bit unsigned integer in big endian format. Read more
fn read_be_u32(&mut self) -> Result<u32, Error>
[src]
fn read_be_u32(&mut self) -> Result<u32, Error>
[src]A convenience function for reading a 32-bit unsigned integer in big endian format. Read more
fn read_to(&mut self, terminal: u8) -> Result<&[u8], Error>
[src]
fn read_to(&mut self, terminal: u8) -> Result<&[u8], Error>
[src]Reads until either terminal
is encountered or EOF. Read more
fn drop_until(&mut self, terminals: &[u8]) -> Result<usize, Error>
[src]
fn drop_until(&mut self, terminals: &[u8]) -> Result<usize, Error>
[src]Discards the input until one of the bytes in terminals is encountered. Read more
fn drop_through(
&mut self,
terminals: &[u8],
match_eof: bool
) -> Result<(Option<u8>, usize), Error>
[src]
fn drop_through(
&mut self,
terminals: &[u8],
match_eof: bool
) -> Result<(Option<u8>, usize), Error>
[src]Discards the input until one of the bytes in terminals
is
encountered. Read more
fn steal(&mut self, amount: usize) -> Result<Vec<u8, Global>, Error>
[src]
fn steal(&mut self, amount: usize) -> Result<Vec<u8, Global>, Error>
[src]Like data_consume_hard()
, but returns the data in a
caller-owned buffer. Read more
fn steal_eof(&mut self) -> Result<Vec<u8, Global>, Error>
[src]
fn steal_eof(&mut self) -> Result<Vec<u8, Global>, Error>
[src]Like steal()
, but instead of stealing a fixed number of
bytes, steals all of the data until the end of file. Read more
fn drop_eof(&mut self) -> Result<bool, Error>
[src]
fn drop_eof(&mut self) -> Result<bool, Error>
[src]Like steal_eof()
, but instead of returning the data, the
data is discarded. Read more
fn dump(&self, sink: &mut dyn Write) -> Result<(), Error>
[src]
fn dump(&self, sink: &mut dyn Write) -> Result<(), Error>
[src]A helpful debugging aid to pretty print a Buffered Reader stack. Read more
fn as_boxed<'a>(self) -> Box<dyn BufferedReader<C> + 'a, Global>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
where
Self: 'a,
[src]
fn as_boxed<'a>(self) -> Box<dyn BufferedReader<C> + 'a, Global>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
where
Self: 'a,
[src]Boxes the reader.
impl Read for Reader<'_>
[src]
impl Read for Reader<'_>
[src]fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
1.36.0[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
1.36.0[src]Like read
, except that it reads into a slice of buffers. Read more
fn is_read_vectored(&self) -> bool
[src]
fn is_read_vectored(&self) -> bool
[src]can_vector
)Determines if this Read
er has an efficient read_vectored
implementation. Read more
unsafe fn initializer(&self) -> Initializer
[src]
unsafe fn initializer(&self) -> Initializer
[src]read_initializer
)Determines if this Read
er can work with buffers of uninitialized
memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]Creates a “by reference” adaptor for this instance of Read
. Read more
Auto Trait Implementations
impl<'a> !RefUnwindSafe for Reader<'a>
impl<'a> Send for Reader<'a>
impl<'a> Sync for Reader<'a>
impl<'a> Unpin for Reader<'a>
impl<'a> !UnwindSafe for Reader<'a>
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self