summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2020-04-21 15:44:24 +0200
committerJustus Winter <justus@sequoia-pgp.org>2020-04-21 15:45:14 +0200
commit50c6526133ae72adc26800f3cc8e9884dab88518 (patch)
treec7f38c81d6cbf511f74ce9b43d3db4e3e78f5a84
parent040542a83e6a2c7d679a9a58068e5f4b86ff7507 (diff)
openpgp: Improve docs.
- We finalize the writer stack at the end of the streaming operation, but we build the filters using the builder pattern.
-rw-r--r--openpgp/src/serialize/stream.rs8
1 files changed, 4 insertions, 4 deletions
diff --git a/openpgp/src/serialize/stream.rs b/openpgp/src/serialize/stream.rs
index a784ba46..a4d3f27f 100644
--- a/openpgp/src/serialize/stream.rs
+++ b/openpgp/src/serialize/stream.rs
@@ -1068,7 +1068,7 @@ impl<'a> Signer<'a> {
self
}
- /// Finalizes the signer, returning the writer stack.
+ /// Builds the signer, returning the writer stack.
///
/// The most useful filter to push to the writer stack next is the
/// [`LiteralWriter`]. Note, if you are creating a signed OpenPGP
@@ -1403,7 +1403,7 @@ impl<'a> LiteralWriter<'a> {
Ok(self)
}
- /// Finalizes the literal writer, returning the writer stack.
+ /// Builds the literal writer, returning the writer stack.
///
/// The next step is to write the payload to the writer stack.
///
@@ -1643,7 +1643,7 @@ impl<'a> Compressor<'a> {
self
}
- /// Finalizes the compressor, returning the writer stack.
+ /// Builds the compressor, returning the writer stack.
///
/// The most useful filter to push to the writer stack next is the
/// [`Signer`] or the [`LiteralWriter`]. Finally, literal data
@@ -2421,7 +2421,7 @@ impl<'a> Encryptor<'a> {
// A page, 3 per mille overhead.
const AEAD_CHUNK_SIZE : usize = 4096;
- /// Finalizes the encryptor, returning the writer stack.
+ /// Builds the encryptor, returning the writer stack.
///
/// The most useful filters to push to the writer stack next are
/// the [`Padder`] or [`Compressor`], and after that the