diff options
| author | Neal H. Walfield <neal@pep.foundation> | 2020-06-19 15:07:17 +0200 |
|---|---|---|
| committer | Neal H. Walfield <neal@pep.foundation> | 2020-06-19 15:09:00 +0200 |
| commit | 05ad615487c4735b16b049adde2ecbb1e3418df6 (patch) | |
| tree | a496dc9a156e517f2c258207d2f8f27e86a087fc /openpgp | |
| parent | 33dfdc57f5f785c3c28320bf45b3b267eec3a85a (diff) | |
openpgp: Improve documentation.
- Mention the type that the `KeyAmalgamationIter` and
`ValidKeyAmalgamationIter` iterators are over.
Diffstat (limited to 'openpgp')
| -rw-r--r-- | openpgp/src/cert/amalgamation/key/iter.rs | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/openpgp/src/cert/amalgamation/key/iter.rs b/openpgp/src/cert/amalgamation/key/iter.rs index 28efdfb0..c94cb559 100644 --- a/openpgp/src/cert/amalgamation/key/iter.rs +++ b/openpgp/src/cert/amalgamation/key/iter.rs @@ -16,6 +16,8 @@ use crate::{ /// An iterator over `Key`s. /// +/// An iterator over [`KeyAmalgamation`]s. +/// /// A `KeyAmalgamationIter` is like a [`ComponentAmalgamationIter`], /// but specialized for keys. Refer to the [module documentation] for /// an explanation of why a different type is necessary. @@ -42,6 +44,7 @@ use crate::{ /// /// A `KeyAmalgamationIter` is returned by [`Cert::keys`]. /// +/// [`KeyAmalgamation`]: struct.KeyAmalgamation.html /// [`ComponentAmalgamationIter`]: ../struct.ComponentAmalgamationIter.html /// [module documentation]: index.html /// [`KeyAmalgamationIter::with_policy`]: ../trait.ValidateAmalgamation.html @@ -496,12 +499,14 @@ impl<'a, P, R> KeyAmalgamationIter<'a, P, R> /// An iterator over valid `Key`s. /// -/// A `ValidComponentAmalgamationIter` is a [`KeyAmalgamationIter`] +/// An iterator over [`ValidKeyAmalgamation`]s. +/// +/// A `ValidKeyAmalgamationIter` is a [`KeyAmalgamationIter`] /// that includes a [`Policy`] and a reference time, which it firstly /// uses to only return valid `Key`s. (For a definition of valid /// keys, see the documentation for [`ValidateAmalgamation`].) /// -/// A `ValidComponentAmalgamationIter` also provides additional +/// A `ValidKeyAmalgamationIter` also provides additional /// filters based on information available in the `Key`s' binding /// signatures. For instance, [`ValidKeyAmalgamationIter::revoked`] /// filters the returned `Key`s by whether or not they are revoked. @@ -564,6 +569,7 @@ impl<'a, P, R> KeyAmalgamationIter<'a, P, R> /// # } /// ``` /// +/// [`ValidKeyAmalgamation`]: struct.ValidKeyAmalgamation.html /// [`KeyAmalgamationIter`]: struct.KeyAmalgamationIter.html /// [`Policy`]: ../../../policy/trait.Policy.html /// [`ValidateAmalgamation`]: ../trait.ValidateAmalgamation.html |