summaryrefslogtreecommitdiffstats
path: root/openpgp/src
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2020-08-06 11:19:52 +0200
committerJustus Winter <justus@sequoia-pgp.org>2020-08-06 11:19:52 +0200
commitaaeb3447b692819bfb16990dfdd44d384eff1e14 (patch)
tree48fdab51ce484781d1f970981b63dd1490006545 /openpgp/src
parent30fa2d80ac627324350f1533c5630f25ecc9cedc (diff)
openpgp: Fix formatting of vector and array literals in examples.
- Align our examples with how the code in the examples of the Rust standard library is formatted. We are writing examples in the hope that downstream users will copy fragments of them, therefore using idiomatic formatting in these snippets is important.
Diffstat (limited to 'openpgp/src')
-rw-r--r--openpgp/src/armor.rs2
-rw-r--r--openpgp/src/cert/amalgamation.rs4
-rw-r--r--openpgp/src/cert/amalgamation/key/iter.rs4
-rw-r--r--openpgp/src/cert/builder.rs4
-rw-r--r--openpgp/src/cert/mod.rs14
-rw-r--r--openpgp/src/message/mod.rs8
-rw-r--r--openpgp/src/packet/mod.rs8
-rw-r--r--openpgp/src/packet/signature/subpacket.rs12
-rw-r--r--openpgp/src/packet_pile.rs18
-rw-r--r--openpgp/src/types/features.rs10
-rw-r--r--openpgp/src/types/key_flags.rs6
-rw-r--r--openpgp/src/types/mod.rs2
-rw-r--r--openpgp/src/types/revocation_key.rs4
-rw-r--r--openpgp/src/types/server_preferences.rs6
14 files changed, 51 insertions, 51 deletions
diff --git a/openpgp/src/armor.rs b/openpgp/src/armor.rs
index 2425c804..b69e890b 100644
--- a/openpgp/src/armor.rs
+++ b/openpgp/src/armor.rs
@@ -193,7 +193,7 @@ impl<W: Write> Writer<W> {
/// # fn main() { f().unwrap(); }
/// # fn f() -> std::io::Result<()> {
/// let mut writer = Writer::with_headers(Vec::new(), Kind::File,
- /// vec![ ("Key", "Value") ])?;
+ /// vec![("Key", "Value")])?;
/// writer.write_all(b"Hello world!")?;
/// let buffer = writer.finalize()?;
/// assert_eq!(
diff --git a/openpgp/src/cert/amalgamation.rs b/openpgp/src/cert/amalgamation.rs
index 8f887166..42a0fc5f 100644
--- a/openpgp/src/cert/amalgamation.rs
+++ b/openpgp/src/cert/amalgamation.rs
@@ -858,14 +858,14 @@ impl<'a, C> ComponentAmalgamation<'a, C> {
/// // Make Alice a designated revoker for Bob.
/// let (bob, _) =
/// CertBuilder::general_purpose(None, Some("bob@example.org"))
- /// .set_revocation_keys(vec![ (&alice).into() ])
+ /// .set_revocation_keys(vec![(&alice).into()])
/// .generate()?;
///
/// // Make sure Alice is listed as a designated revoker for Bob
/// // on a component.
/// assert_eq!(bob.with_policy(p, None)?.primary_userid()?.revocation_keys(p)
/// .collect::<Vec<&RevocationKey>>(),
- /// vec![ &(&alice).into() ]);
+ /// vec![&(&alice).into()]);
/// # Ok(()) }
/// ```
pub fn revocation_keys(&self, policy: &dyn Policy)
diff --git a/openpgp/src/cert/amalgamation/key/iter.rs b/openpgp/src/cert/amalgamation/key/iter.rs
index d14fdc0b..f50a8118 100644
--- a/openpgp/src/cert/amalgamation/key/iter.rs
+++ b/openpgp/src/cert/amalgamation/key/iter.rs
@@ -365,7 +365,7 @@ impl<'a, P, R> KeyAmalgamationIter<'a, P, R>
/// # let (cert, _) =
/// # CertBuilder::general_purpose(None, Some("alice@example.org"))
/// # .generate()?;
- /// # let key_handles = &[ cert.primary_key().key_handle() ][..];
+ /// # let key_handles = &[cert.primary_key().key_handle()][..];
/// # let mut i = 0;
/// for ka in cert.keys().key_handles(key_handles.iter()) {
/// // Use it.
@@ -1429,7 +1429,7 @@ impl<'a, P, R> ValidKeyAmalgamationIter<'a, P, R>
/// # let (cert, _) =
/// # CertBuilder::general_purpose(None, Some("alice@example.org"))
/// # .generate()?;
- /// # let key_handles = &[ cert.primary_key().key_handle() ][..];
+ /// # let key_handles = &[cert.primary_key().key_handle()][..];
/// # let mut i = 0;
/// for ka in cert.keys().with_policy(p, None).key_handles(key_handles.iter()) {
/// // Use it.
diff --git a/openpgp/src/cert/builder.rs b/openpgp/src/cert/builder.rs
index 1f725732..e6a6f6bf 100644
--- a/openpgp/src/cert/builder.rs
+++ b/openpgp/src/cert/builder.rs
@@ -902,12 +902,12 @@ impl CertBuilder {
/// .generate()?;
/// let (bob, _) =
/// CertBuilder::general_purpose(None, Some("bob@example.org"))
- /// .set_revocation_keys(vec![ (&alice).into() ])
+ /// .set_revocation_keys(vec![(&alice).into()])
/// .generate()?;
///
/// // Make sure Alice is listed as a designated revoker for Bob.
/// assert_eq!(bob.revocation_keys(p).collect::<Vec<&RevocationKey>>(),
- /// vec![ &(&alice).into() ]);
+ /// vec![&(&alice).into()]);
/// # Ok(()) }
/// ```
pub fn set_revocation_keys(mut self, revocation_keys: Vec<RevocationKey>)
diff --git a/openpgp/src/cert/mod.rs b/openpgp/src/cert/mod.rs
index 75695e82..3ce25e8f 100644
--- a/openpgp/src/cert/mod.rs
+++ b/openpgp/src/cert/mod.rs
@@ -819,7 +819,7 @@ impl Cert {
/// // to be revoked.
/// let cert = cert.merge_packets(rev.clone())?;
/// assert_eq!(cert.revocation_status(p, None),
- /// RevocationStatus::Revoked(vec![ &rev.into() ]));
+ /// RevocationStatus::Revoked(vec![&rev.into()]));
/// # Ok(())
/// # }
/// ```
@@ -1228,12 +1228,12 @@ impl Cert {
/// // Make Alice a designated revoker for Bob.
/// let (bob, _) =
/// CertBuilder::general_purpose(None, Some("bob@example.org"))
- /// .set_revocation_keys(vec![ (&alice).into() ])
+ /// .set_revocation_keys(vec![(&alice).into()])
/// .generate()?;
///
/// // Make sure Alice is listed as a designated revoker for Bob.
/// assert_eq!(bob.revocation_keys(p).collect::<Vec<&RevocationKey>>(),
- /// vec![ &(&alice).into() ]);
+ /// vec![&(&alice).into()]);
/// # Ok(()) }
/// ```
pub fn revocation_keys<'a>(&'a self, policy: &dyn Policy)
@@ -1315,7 +1315,7 @@ impl Cert {
///
/// // But a revocation certificate is not a certificate, so this
/// // will fail.
- /// let p : Vec<Packet> = vec![ rev.into() ];
+ /// let p : Vec<Packet> = vec![rev.into()];
/// assert!(Cert::from_packets(p.into_iter()).is_err());
/// # Ok(())
/// # }
@@ -2713,7 +2713,7 @@ impl<'a> ValidCert<'a> {
/// // to be revoked.
/// let cert = cert.merge_packets(rev.clone())?;
/// assert_eq!(cert.with_policy(p, None)?.revocation_status(),
- /// RevocationStatus::Revoked(vec![ &rev.into() ]));
+ /// RevocationStatus::Revoked(vec![&rev.into()]));
/// # Ok(())
/// # }
/// ```
@@ -2920,7 +2920,7 @@ impl<'a> ValidCert<'a> {
/// .set_primary_userid(false)?;
/// let bob: UserID = "Bob".into();
/// let sig = bob.bind(&mut signer, &cert, sig)?;
- /// let cert = cert.merge_packets(vec![ Packet::from(bob), sig.into() ])?;
+ /// let cert = cert.merge_packets(vec![Packet::from(bob), sig.into()])?;
/// # assert_eq!(cert.userids().count(), 2);
///
/// // Alice should still be the primary User ID, because it has the
@@ -2935,7 +2935,7 @@ impl<'a> ValidCert<'a> {
/// .set_signature_creation_time(t2)?;
/// let carol: UserID = "Carol".into();
/// let sig = carol.bind(&mut signer, &cert, sig)?;
- /// let cert = cert.merge_packets(vec![ Packet::from(carol), sig.into() ])?;
+ /// let cert = cert.merge_packets(vec![Packet::from(carol), sig.into()])?;
/// # assert_eq!(cert.userids().count(), 3);
///
/// // It should now be the primary User ID, because it is the
diff --git a/openpgp/src/message/mod.rs b/openpgp/src/message/mod.rs
index 9c30f74f..b0763669 100644
--- a/openpgp/src/message/mod.rs
+++ b/openpgp/src/message/mod.rs
@@ -167,8 +167,8 @@ impl MessageValidator {
/// Add the token `token` at position `path` to the token stream.
///
- /// Note: top-level packets are at `[ n ]`, their immediate
- /// children are at `[ n, m ]`, etc.
+ /// Note: top-level packets are at `[n]`, their immediate
+ /// children are at `[n, m]`, etc.
///
/// This function pushes any required `Token::Pop` tokens based on
/// changes in the `path`.
@@ -200,8 +200,8 @@ impl MessageValidator {
/// Add a packet of type `tag` at position `path` to the token
/// stream.
///
- /// Note: top-level packets are at `[ n ]`, their immediate
- /// children are at `[ n, m ]`, etc.
+ /// Note: top-level packets are at `[n]`, their immediate
+ /// children are at `[n, m]`, etc.
///
/// Unlike `push_token`, this function does not automatically
/// account for changes in the depth. If you use this function
diff --git a/openpgp/src/packet/mod.rs b/openpgp/src/packet/mod.rs
index e5aefb45..b0d1dcdb 100644
--- a/openpgp/src/packet/mod.rs
+++ b/openpgp/src/packet/mod.rs
@@ -639,7 +639,7 @@ impl<'a> Iter<'a> {
/// #
/// # let mut cd = CompressedData::new(
/// # CompressionAlgorithm::Uncompressed);
- /// # cd.set_body(packet::Body::Structured(vec![ lit.clone() ]));
+ /// # cd.set_body(packet::Body::Structured(vec![lit.clone()]));
/// # let cd = Packet::from(cd);
/// #
/// # // Make sure we created the message correctly: serialize,
@@ -650,9 +650,9 @@ impl<'a> Iter<'a> {
/// # let pp = PacketPile::from_bytes(&bytes[..])?;
/// #
/// # assert_eq!(pp.descendants().count(), 2);
- /// # assert_eq!(pp.path_ref(&[ 0 ]).unwrap().tag(),
+ /// # assert_eq!(pp.path_ref(&[0]).unwrap().tag(),
/// # packet::Tag::CompressedData);
- /// # assert_eq!(pp.path_ref(&[ 0, 0 ]), Some(&lit));
+ /// # assert_eq!(pp.path_ref(&[0, 0]), Some(&lit));
/// #
/// # cd
/// # };
@@ -872,7 +872,7 @@ fn packet_path_iter() {
/// .set_signature_creation_time(t2)?;
/// let sig = userid.bind(&mut signer, &cert, sig)?;
///
-/// let cert = cert.merge_packets(vec![ Packet::from(userid), sig.into() ])?;
+/// let cert = cert.merge_packets(vec![Packet::from(userid), sig.into()])?;
/// # assert_eq!(cert.with_policy(p, t2)?.userids().count(), 2);
/// # Ok(()) }
/// ```
diff --git a/openpgp/src/packet/signature/subpacket.rs b/openpgp/src/packet/signature/subpacket.rs
index 4cb1d745..370cac29 100644
--- a/openpgp/src/packet/signature/subpacket.rs
+++ b/openpgp/src/packet/signature/subpacket.rs
@@ -2182,7 +2182,7 @@ impl signature::SignatureBuilder {
/// builder.unhashed_area_mut().add(Subpacket::new(
/// SubpacketValue::Unknown {
/// tag: SubpacketTag::Private(61),
- /// body: [ 0x6D, 0x6F, 0x6F ].to_vec(),
+ /// body: [0x6D, 0x6F, 0x6F].to_vec(),
/// },
/// true)?)?;
/// let sig = builder.sign_message(&mut signer, msg)?;
@@ -2219,7 +2219,7 @@ impl signature::SignatureBuilder {
/// a.add(Subpacket::new(
/// SubpacketValue::Unknown {
/// tag: SubpacketTag::Private(61),
- /// body: [ 0x6D, 0x6F, 0x6F ].to_vec(),
+ /// body: [0x6D, 0x6F, 0x6F].to_vec(),
/// },
/// true)?);
/// Ok(a)
@@ -2269,7 +2269,7 @@ impl signature::SignatureBuilder {
/// a.add(Subpacket::new(
/// SubpacketValue::Unknown {
/// tag: SubpacketTag::Private(61),
- /// body: [ 0x6D, 0x6F, 0x6F ].to_vec(),
+ /// body: [0x6D, 0x6F, 0x6F].to_vec(),
/// },
/// true)?);
/// Ok(a)
@@ -2325,7 +2325,7 @@ impl signature::SignatureBuilder {
/// builder.hashed_area_mut().add(Subpacket::new(
/// SubpacketValue::Unknown {
/// tag: SubpacketTag::Private(61),
- /// body: [ 0x6D, 0x6F, 0x6F ].to_vec(),
+ /// body: [0x6D, 0x6F, 0x6F].to_vec(),
/// },
/// true)?)?;
/// let sig = builder.sign_message(&mut signer, msg)?;
@@ -2362,7 +2362,7 @@ impl signature::SignatureBuilder {
/// a.add(Subpacket::new(
/// SubpacketValue::Unknown {
/// tag: SubpacketTag::Private(61),
- /// body: [ 0x6D, 0x6F, 0x6F ].to_vec(),
+ /// body: [0x6D, 0x6F, 0x6F].to_vec(),
/// },
/// true)?);
/// Ok(a)
@@ -2406,7 +2406,7 @@ impl signature::SignatureBuilder {
/// a.add(Subpacket::new(
/// SubpacketValue::Unknown {
/// tag: SubpacketTag::Private(61),
- /// body: [ 0x6D, 0x6F, 0x6F ].to_vec(),
+ /// body: [0x6D, 0x6F, 0x6F].to_vec(),
/// },
/// true)?)?;
/// Ok(a)
diff --git a/openpgp/src/packet_pile.rs b/openpgp/src/packet_pile.rs
index 07ca3561..cebf4ab2 100644
--- a/openpgp/src/packet_pile.rs
+++ b/openpgp/src/packet_pile.rs
@@ -205,7 +205,7 @@ impl PacketPile {
/// Returns a reference to the packet at the location described by
/// `pathspec`.
///
- /// `pathspec` is a slice of the form `[ 0, 1, 2 ]`. Each element
+ /// `pathspec` is a slice of the form `[0, 1, 2]`. Each element
/// is the index of packet in a container. Thus, the previous
/// path specification means: return the third child of the second
/// child of the first top-level packet. In other words, the
@@ -223,7 +223,7 @@ impl PacketPile {
/// *
/// ```
///
- /// And, `[ 10 ]` means return the 11th top-level packet.
+ /// And, `[10]` means return the 11th top-level packet.
///
/// Note: there is no packet at the root. Thus, the path `[]`
/// returns None.
@@ -238,7 +238,7 @@ impl PacketPile {
/// # fn f() -> Result<()> {
/// # let mut lit = Literal::new(DataFormat::Text);
/// # lit.set_body(b"test".to_vec());
- /// # let packets = vec![ lit.into() ];
+ /// # let packets = vec![lit.into()];
/// let pile = PacketPile::from(packets);
///
/// if let Some(packet) = pile.path_ref(&[0]) {
@@ -293,7 +293,7 @@ impl PacketPile {
/// # fn f() -> Result<()> {
/// # let mut lit = Literal::new(DataFormat::Text);
/// # lit.set_body(b"test".to_vec());
- /// # let packets = vec![ lit.into() ];
+ /// # let packets = vec![lit.into()];
/// let mut pile = PacketPile::from(packets);
///
/// if let Some(ref packet) = pile.path_ref_mut(&[0]) {
@@ -364,8 +364,8 @@ impl PacketPile {
/// let mut literal = Literal::new(DataFormat::Text);
/// literal.set_body(b"new".to_vec());
/// pile.replace(
- /// &[ 0, 0 ], 1,
- /// [ literal.into() ].to_vec())
+ /// &[0, 0], 1,
+ /// [literal.into()].to_vec())
/// .unwrap();
/// # if let Some(Packet::Literal(lit)) = pile.path_ref(&[0, 0]) {
/// # assert_eq!(lit.body(), &b"new"[..], "{:#?}", lit);
@@ -444,7 +444,7 @@ impl PacketPile {
/// let mut lit = Literal::new(DataFormat::Text);
/// lit.set_body(b"test".to_vec());
///
- /// let pile = PacketPile::from(vec![ lit.into() ]);
+ /// let pile = PacketPile::from(vec![lit.into()]);
///
/// for packet in pile.descendants() {
/// assert_eq!(packet.tag(), Tag::Literal);
@@ -467,7 +467,7 @@ impl PacketPile {
/// let mut lit = Literal::new(DataFormat::Text);
/// lit.set_body(b"test".to_vec());
///
- /// let pile = PacketPile::from(vec![ lit.into() ]);
+ /// let pile = PacketPile::from(vec![lit.into()]);
///
/// assert_eq!(pile.children().len(), 1);
/// # Ok(())
@@ -490,7 +490,7 @@ impl PacketPile {
/// let mut lit = Literal::new(DataFormat::Text);
/// lit.set_body(b"test".to_vec());
///
- /// let pile = PacketPile::from(vec![ lit.into() ]);
+ /// let pile = PacketPile::from(vec![lit.into()]);
///
/// for packet in pile.into_children() {
/// assert_eq!(packet.tag(), Tag::Literal);
diff --git a/openpgp/src/types/features.rs b/openpgp/src/types/features.rs
index 1ca88617..7e7e4240 100644
--- a/openpgp/src/types/features.rs
+++ b/openpgp/src/types/features.rs
@@ -132,8 +132,8 @@ impl Features {
/// use openpgp::types::Features;
///
/// # fn main() -> Result<()> {
- /// let a = Features::new(&[ 0x1 ]);
- /// let b = Features::new(&[ 0x1, 0x0 ]);
+ /// let a = Features::new(&[0x1]);
+ /// let b = Features::new(&[0x1, 0x0]);
///
/// assert!(a != b);
/// assert!(a.normalized_eq(&b));
@@ -159,7 +159,7 @@ impl Features {
///
/// # fn main() -> Result<()> {
/// // Feature flags 0 and 2.
- /// let f = Features::new(&[ 0x5 ]);
+ /// let f = Features::new(&[0x5]);
///
/// assert!(f.get(0));
/// assert!(! f.get(1));
@@ -276,7 +276,7 @@ impl Features {
/// use openpgp::types::Features;
///
/// # fn main() -> Result<()> {
- /// let f = Features::new(&[ 0x1 ]);
+ /// let f = Features::new(&[0x1]);
/// assert!(f.supports_mdc());
///
/// let f = f.clear_mdc();
@@ -336,7 +336,7 @@ impl Features {
/// use openpgp::types::Features;
///
/// # fn main() -> Result<()> {
- /// let f = Features::new(&[ 0x2 ]);
+ /// let f = Features::new(&[0x2]);
/// assert!(f.supports_aead());
///
/// let f = f.clear_aead();
diff --git a/openpgp/src/types/key_flags.rs b/openpgp/src/types/key_flags.rs
index e25ce6fb..c6d0890f 100644
--- a/openpgp/src/types/key_flags.rs
+++ b/openpgp/src/types/key_flags.rs
@@ -174,8 +174,8 @@ impl KeyFlags {
/// use openpgp::types::KeyFlags;
///
/// # fn main() -> openpgp::Result<()> {
- /// let a = KeyFlags::new(&[ 0x1 ]);
- /// let b = KeyFlags::new(&[ 0x1, 0x0 ]);
+ /// let a = KeyFlags::new(&[0x1]);
+ /// let b = KeyFlags::new(&[0x1, 0x0]);
///
/// assert!(a != b);
/// assert!(a.normalized_eq(&b));
@@ -195,7 +195,7 @@ impl KeyFlags {
///
/// # fn main() -> openpgp::Result<()> {
/// // Key flags 0 and 2.
- /// let kf = KeyFlags::new(&[ 0x5 ]);
+ /// let kf = KeyFlags::new(&[0x5]);
///
/// assert!(kf.get(0));
/// assert!(! kf.get(1));
diff --git a/openpgp/src/types/mod.rs b/openpgp/src/types/mod.rs
index 82e239ad..db62415b 100644
--- a/openpgp/src/types/mod.rs
+++ b/openpgp/src/types/mod.rs
@@ -1455,7 +1455,7 @@ impl Arbitrary for ReasonForRevocation {
/// let t1 = t0 + Duration::from_secs(1200);
/// let cert1 = cert.clone().merge_packets(sig.clone())?;
/// assert_eq!(cert1.revocation_status(p, Some(t1)),
-/// RevocationStatus::Revoked(vec![ &sig.into() ]));
+/// RevocationStatus::Revoked(vec![&sig.into()]));
///
/// // Create a soft revocation (KeySuperseded):
/// let sig = CertRevocationBuilder::new()
diff --git a/openpgp/src/types/revocation_key.rs b/openpgp/src/types/revocation_key.rs
index 90e65ea7..8064a148 100644
--- a/openpgp/src/types/revocation_key.rs
+++ b/openpgp/src/types/revocation_key.rs
@@ -42,14 +42,14 @@ use crate::{
/// // Make Alice a designated revoker for Bob.
/// let (bob, _) =
/// CertBuilder::general_purpose(None, Some("bob@example.org"))
-/// .set_revocation_keys(vec![ (&alice).into() ])
+/// .set_revocation_keys(vec![(&alice).into()])
/// .generate()?;
///
/// // Make sure Alice is listed as a designated revoker for Bob
/// // on a component.
/// assert_eq!(bob.with_policy(p, None)?.primary_userid()?.revocation_keys(p)
/// .collect::<Vec<&RevocationKey>>(),
-/// vec![ &(&alice).into() ]);
+/// vec![&(&alice).into()]);
/// # Ok(()) }
/// ```
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
diff --git a/openpgp/src/types/server_preferences.rs b/openpgp/src/types/server_preferences.rs
index d129ef00..42425d47 100644
--- a/openpgp/src/types/server_preferences.rs
+++ b/openpgp/src/types/server_preferences.rs
@@ -118,8 +118,8 @@ impl KeyServerPreferences {
/// use openpgp::types::KeyServerPreferences;
///
/// # fn main() -> openpgp::Result<()> {
- /// let a = KeyServerPreferences::new(&[ 0x1 ]);
- /// let b = KeyServerPreferences::new(&[ 0x1, 0x0 ]);
+ /// let a = KeyServerPreferences::new(&[0x1]);
+ /// let b = KeyServerPreferences::new(&[0x1, 0x0]);
///
/// assert!(a != b);
/// assert!(a.normalized_eq(&b));
@@ -139,7 +139,7 @@ impl KeyServerPreferences {
///
/// # fn main() -> openpgp::Result<()> {
/// // Keyserver Preferences flags 0 and 2.
- /// let ksp = KeyServerPreferences::new(&[ 0x5 ]);
+ /// let ksp = KeyServerPreferences::new(&[0x5]);
///
/// assert!(ksp.get(0));
/// assert!(! ksp.get(1));