[][src]Struct sequoia_openpgp::armor::Writer

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

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

Implementations

impl<W: Write> Writer<W>[src]

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

Constructs a new filter for the given type of data.

Note: To ensure that we can handle errors during writing of the armor footer, this object must be consumed by calling Writer::finalize(). If the object is dropped without being finalized, we will panic in debug builds.

Example

use std::io::{Read, Write, Cursor};
use sequoia_openpgp as openpgp;
use openpgp::armor::{Writer, Kind};
let mut writer = Writer::new(Vec::new(), Kind::File,
    &[ ("Key", "Value") ][..])?;
writer.write_all(b"Hello world!")?;
let buffer = writer.finalize()?;
assert_eq!(
    String::from_utf8_lossy(&buffer),
    "-----BEGIN PGP ARMORED FILE-----
Key: Value

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

pub fn finalize(self) -> Result<W>[src]

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>[src]

impl<W: Write> Write for Writer<W>[src]

Auto Trait Implementations

impl<W> RefUnwindSafe for Writer<W> where
    W: RefUnwindSafe

impl<W> Send for Writer<W> where
    W: Send

impl<W> Sync for Writer<W> where
    W: Sync

impl<W> Unpin for Writer<W> where
    W: Unpin

impl<W> UnwindSafe for Writer<W> where
    W: UnwindSafe

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>,