Struct Writer 

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

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

Implementations

impl<W: Write> Writer<W>

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

Constructs a new filter for the given type of data.

Examples

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

Constructs a new filter for the given type of data.

Examples

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 set_profile(&mut self, profile: Profile) -> Result<()>

Sets the version of OpenPGP to generate ASCII Armor for.

This function can only be called once. Calling it repeatedly will return an error.

Examples

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.set_profile(openpgp::Profile::RFC9580)?;
writer.set_profile(openpgp::Profile::RFC9580).unwrap_err();
writer.set_profile(openpgp::Profile::RFC4880).unwrap_err();

writer.write_all(b"Hello world!")?;
let buffer = writer.finalize()?;
assert_eq!(
    String::from_utf8_lossy(&buffer),
    "-----BEGIN PGP ARMORED FILE-----

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

pub fn get_ref(&self) -> &W

Returns a reference to the inner writer.

pub fn get_mut(&mut self) -> &mut W

Returns a mutable reference to the inner writer.

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

Writes the footer.

This function needs to be called explicitly before the writer is dropped.

Trait Implementations

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

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

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

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

Flushes 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 is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

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

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.