summaryrefslogtreecommitdiffstats
path: root/guide
diff options
context:
space:
mode:
authorWiktor Kwapisiewicz <wiktor@metacode.biz>2020-09-17 09:50:33 +0200
committerWiktor Kwapisiewicz <wiktor@metacode.biz>2020-09-21 09:32:16 +0200
commitba79017328ce7dc444ee05a83f3a04f4f6ba9310 (patch)
tree0bb0a94f82571b0956a31461960529d13b77155c /guide
parent2de4c6750e48f587cbdc3691bdb17e2a23502978 (diff)
guide: Call all layers of the message `message`.
- Rename `literal_writer` to `message`, - Rename `signer` to `message`, - Rename `encryptor` to `message`.
Diffstat (limited to 'guide')
-rw-r--r--guide/src/chapter_01.md32
-rw-r--r--guide/src/chapter_02.md44
2 files changed, 38 insertions, 38 deletions
diff --git a/guide/src/chapter_01.md b/guide/src/chapter_01.md
index 5313042b..f1dbc653 100644
--- a/guide/src/chapter_01.md
+++ b/guide/src/chapter_01.md
@@ -68,17 +68,17 @@ fn main() -> openpgp::Result<()> {
# let message = Message::new(sink);
#
# // We want to sign a literal data packet.
-# let signer = Signer::new(message, keypair).build()?;
+# let message = Signer::new(message, keypair).build()?;
#
# // Emit a literal data packet.
-# let mut literal_writer = LiteralWriter::new(signer).build()?;
+# let mut message = LiteralWriter::new(message).build()?;
#
# // Sign the data.
-# literal_writer.write_all(plaintext.as_bytes())?;
+# message.write_all(plaintext.as_bytes())?;
#
# // Finalize the OpenPGP message to make sure that all data is
# // written.
-# literal_writer.finalize()?;
+# message.finalize()?;
#
# Ok(())
# }
@@ -219,17 +219,17 @@ fn generate() -> openpgp::Result<openpgp::Cert> {
# let message = Message::new(sink);
#
# // We want to sign a literal data packet.
-# let signer = Signer::new(message, keypair).build()?;
+# let message = Signer::new(message, keypair).build()?;
#
# // Emit a literal data packet.
-# let mut literal_writer = LiteralWriter::new(signer).build()?;
+# let mut message = LiteralWriter::new(message).build()?;
#
# // Sign the data.
-# literal_writer.write_all(plaintext.as_bytes())?;
+# message.write_all(plaintext.as_bytes())?;
#
# // Finalize the OpenPGP message to make sure that all data is
# // written.
-# literal_writer.finalize()?;
+# message.finalize()?;
#
# Ok(())
# }
@@ -370,17 +370,17 @@ fn sign(policy: &dyn Policy,
let message = Message::new(sink);
// We want to sign a literal data packet.
- let signer = Signer::new(message, keypair).build()?;
+ let message = Signer::new(message, keypair).build()?;
// Emit a literal data packet.
- let mut literal_writer = LiteralWriter::new(signer).build()?;
+ let mut message = LiteralWriter::new(message).build()?;
// Sign the data.
- literal_writer.write_all(plaintext.as_bytes())?;
+ message.write_all(plaintext.as_bytes())?;
// Finalize the OpenPGP message to make sure that all data is
// written.
- literal_writer.finalize()?;
+ message.finalize()?;
Ok(())
}
@@ -532,17 +532,17 @@ Verified data can be read from this using [`io::Read`].
# let message = Message::new(sink);
#
# // We want to sign a literal data packet.
-# let signer = Signer::new(message, keypair).build()?;
+# let message = Signer::new(message, keypair).build()?;
#
# // Emit a literal data packet.
-# let mut literal_writer = LiteralWriter::new(signer).build()?;
+# let mut message = LiteralWriter::new(message).build()?;
#
# // Sign the data.
-# literal_writer.write_all(plaintext.as_bytes())?;
+# message.write_all(plaintext.as_bytes())?;
#
# // Finalize the OpenPGP message to make sure that all data is
# // written.
-# literal_writer.finalize()?;
+# message.finalize()?;
#
# Ok(())
# }
diff --git a/guide/src/chapter_02.md b/guide/src/chapter_02.md
index d1bed514..052d59b8 100644
--- a/guide/src/chapter_02.md
+++ b/guide/src/chapter_02.md
@@ -61,22 +61,22 @@ fn main() -> openpgp::Result<()> {
# recipient.keys().with_policy(policy, None).alive().revoked(false)
# .for_transport_encryption();
#
-# // Start streaming an OpenPGP message.
-# let message = Message::new(sink);
+# // Start streaming an OpenPGP message.
+# let message = Message::new(sink);
#
# // We want to encrypt a literal data packet.
-# let encryptor = Encryptor::for_recipients(message, recipients)
+# let message = Encryptor::for_recipients(message, recipients)
# .build()?;
#
# // Emit a literal data packet.
-# let mut literal_writer = LiteralWriter::new(encryptor).build()?;
+# let mut message = LiteralWriter::new(message).build()?;
#
# // Encrypt the data.
-# literal_writer.write_all(plaintext.as_bytes())?;
+# message.write_all(plaintext.as_bytes())?;
#
# // Finalize the OpenPGP message to make sure that all data is
# // written.
-# literal_writer.finalize()?;
+# message.finalize()?;
#
# Ok(())
# }
@@ -209,22 +209,22 @@ fn generate() -> openpgp::Result<openpgp::Cert> {
# recipient.keys().with_policy(policy, None).alive().revoked(false)
# .for_transport_encryption();
#
-# // Start streaming an OpenPGP message.
-# let message = Message::new(sink);
+# // Start streaming an OpenPGP message.
+# let message = Message::new(sink);
#
# // We want to encrypt a literal data packet.
-# let encryptor = Encryptor::for_recipients(message, recipients)
+# let message = Encryptor::for_recipients(message, recipients)
# .build()?;
#
# // Emit a literal data packet.
-# let mut literal_writer = LiteralWriter::new(encryptor).build()?;
+# let mut message = LiteralWriter::new(message).build()?;
#
# // Encrypt the data.
-# literal_writer.write_all(plaintext.as_bytes())?;
+# message.write_all(plaintext.as_bytes())?;
#
# // Finalize the OpenPGP message to make sure that all data is
# // written.
-# literal_writer.finalize()?;
+# message.finalize()?;
#
# Ok(())
# }
@@ -361,18 +361,18 @@ fn encrypt(policy: &dyn Policy,
let message = Message::new(sink);
// We want to encrypt a literal data packet.
- let encryptor = Encryptor::for_recipients(message, recipients)
+ let message = Encryptor::for_recipients(message, recipients)
.build()?;
// Emit a literal data packet.
- let mut literal_writer = LiteralWriter::new(encryptor).build()?;
+ let mut message = LiteralWriter::new(message).build()?;
// Encrypt the data.
- literal_writer.write_all(plaintext.as_bytes())?;
+ message.write_all(plaintext.as_bytes())?;
// Finalize the OpenPGP message to make sure that all data is
// written.
- literal_writer.finalize()?;
+ message.finalize()?;
Ok(())
}
@@ -519,22 +519,22 @@ Decrypted data can be read from this using [`io::Read`].
# recipient.keys().with_policy(policy, None).alive().revoked(false)
# .for_transport_encryption();
#
-# // Start streaming an OpenPGP message.
-# let message = Message::new(sink);
+# // Start streaming an OpenPGP message.
+# let message = Message::new(sink);
#
# // We want to encrypt a literal data packet.
-# let encryptor = Encryptor::for_recipients(message, recipients)
+# let message = Encryptor::for_recipients(message, recipients)
# .build()?;
#
# // Emit a literal data packet.
-# let mut literal_writer = LiteralWriter::new(encryptor).build()?;
+# let mut message = LiteralWriter::new(message).build()?;
#
# // Encrypt the data.
-# literal_writer.write_all(plaintext.as_bytes())?;
+# message.write_all(plaintext.as_bytes())?;
#
# // Finalize the OpenPGP message to make sure that all data is
# // written.
-# literal_writer.finalize()?;
+# message.finalize()?;
#
# Ok(())
# }