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

Methods

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

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

Constructs a new filter for the given type of data.

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)?;
writer.write_all(b"Hello world!")?;
let buffer = writer.finalize()?;
assert_eq!(
    String::from_utf8_lossy(&buffer),
    "-----BEGIN PGP ARMORED FILE-----

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

pub fn with_headers<I, K, V>(inner: W, kind: Kind, headers: I) -> Result<Self> where
    I: IntoIterator<Item = (K, V)>,
    K: AsRef<str>,
    V: AsRef<str>, 
[src]

Constructs a new filter for the given type of data.

Example

use std::io::{Read, Write, Cursor};
use sequoia_openpgp as openpgp;
use openpgp::armor::{Writer, Kind};
let mut writer = Writer::with_headers(Vec::new(), Kind::File,
    vec![ ("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 get_ref(&self) -> &W[src]

Returns a reference to the inner writer.

pub fn get_mut(&mut self) -> &mut W[src]

Returns a mutable reference to the inner writer.

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> Write for Writer<W>[src]

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

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

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

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

Attempts to write an entire buffer into this writer. Read more

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

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

fn by_ref(&mut self) -> &mut Self
1.0.0
[src]

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

Auto Trait Implementations

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

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

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto 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 for T where
    V: MultiLane<T>,