Struct sequoia_openpgp::armor::Writer

pub struct Writer<W: Write> { /* fields omitted */ }

A filter that applies ASCII Armor to the data written to it.

Methods

impl<W: Write> Writer<W>

pub fn new(inner: W, kind: Kind, headers: &[(&str, &str)]) -> Result<Self>

Constructs a new filter for the given type of data.

Example

let mut buffer = io::Cursor::new(vec![]);
{
    let mut writer = Writer::new(&mut buffer, Kind::File,
        &[ ("Key", "Value") ][..])?;
    writer.write_all(b"Hello world!")?;
    // writer is drop()ed here.
}
assert_eq!(
    String::from_utf8_lossy(buffer.get_ref()),
    "-----BEGIN PGP ARMORED FILE-----
Key: Value

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

pub fn finalize(self) -> Result<W>

Writes the footer.

No more data can be written after this call. If this is not called explicitly, the footer is written once the writer is dropped.

Trait Implementations

impl<W: Write> Drop for Writer<W>

fn drop(&mut self)

Executes the destructor for this type.

impl<W: Write> Write for Writer<W>

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

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

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

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

Creates a "by reference" adaptor for this instance of Write.