[][src]Struct sequoia_openpgp::cert::components::KeyIter

pub struct KeyIter<'a, P: KeyParts> { /* fields omitted */ }

An iterator over all Keys (both the primary key and the subkeys) in a certificate.

Returned by Cert::keys().

KeyIter follows the builder pattern. There is no need to explicitly finalize it, however: it already implements the Iterator trait.

By default, KeyIter returns all keys. KeyIter provides some filters to control what it returns. For instance, KeyIter::secret causes the iterator to only returns keys that include secret key material. Of course, since KeyIter implements Iterator, it is possible to use Iterator::filter to implement custom filters.

Methods

impl<'a, P: 'a + KeyParts> KeyIter<'a, P>[src]

Important traits for KeyIter<'a, PublicParts>
pub fn secret(self) -> KeyIter<'a, SecretParts>[src]

Changes the filter to only return keys with secret key material.

Important traits for KeyIter<'a, PublicParts>
pub fn unencrypted_secret(self) -> KeyIter<'a, SecretParts>[src]

Changes the filter to only return keys with unencrypted secret key material.

pub fn key_handle<H>(self, h: H) -> Self where
    H: Into<KeyHandle>, 
[src]

Only returns a key if it matches the specified handle.

Note: this function is cumulative. If you call this function (or key_handles) multiple times, then the iterator returns a key if it matches any of the specified handles.

pub fn key_handles<'b>(self, h: impl Iterator<Item = &'b KeyHandle>) -> Self where
    'a: 'b, 
[src]

Only returns a key if it matches any of the specified handles.

Note: this function is cumulative. If you call this function (or key_handle) multiple times, then the iterator returns a key if it matches any of the specified handles.

pub fn skip_primary(self) -> Self[src]

Changes the iterator to skip the primary key.

pub fn with_policy<T>(
    self,
    policy: &'a dyn Policy,
    time: T
) -> ValidKeyIter<'a, P> where
    T: Into<Option<SystemTime>>, 
[src]

Changes the iterator to only return keys that are valid at time time.

If time is None, then the current time is used.

See ValidKeyIter for the definition of a valid key.

This also makes a number of filters like alive and revoked available and causes the iterator to return a KeyAmalgamation instead of a bare Key.

As a general rule of thumb, when encrypting or signing a message, you only want to use keys that are alive, not revoked, and have the appropriate capabilities keys right now. For example:

use openpgp::types::RevocationStatus;
use sequoia_openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

if let RevocationStatus::Revoked(_) = cert.revoked(p, None) {
    // The certificate is revoked, don't use any keys from it.
} else if let Err(_) = cert.alive(p, None) {
    // The certificate is not alive, don't use any keys from it.
} else {
    for key in cert.keys().with_policy(p, None).alive().revoked(false).for_signing() {
        // We can sign the message with this key.
    }
}

When verifying a message, you only want to use keys that were alive, not revoked, and signing capable when the message was signed. These are the only keys that the signer could have used; anything else suggests an attack, e.g., a forged time stamp.

For version 4 Signature packets, the Signature Creation Time subpacket indicates when the signature was allegedly created. For the purpose of finding the key to verify the signature, this time stamp should be trusted.

use openpgp::types::RevocationStatus;
use sequoia_openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

if let RevocationStatus::Revoked(_) = cert.revoked(p, None) {
    // The certificate is revoked, don't use any keys from it.
} else if let Err(_) = cert.alive(p, None) {
    // The certificate is not alive, don't use any keys from it.
} else {
    for key in cert.keys().with_policy(p, timestamp).alive().revoked(false).for_signing() {
        // Verify the message with this keys.
    }
}

Similarly, when decrypting a message, you should only consider keys that were alive, not revoked, and encryption-capable when the message was encrypted. Unfortunately, we don't know when a message was encrypted. This, of course, precludes checking the key's liveness, its revocation status, and its key capabilities at the time of encryption.

Decrypting a message encrypt to an expired or revoked key is not a security problem. In fact, due to the slow propagation of revocation certificates, it is better to not ignore revoked keys in this case. However, checking whether a key is encryption capable is important. [This discussion] explains why using a signing key to decrypt a message can be dangerous.

A possible workaround is to check whether the key is encryption capable now. Since a key's key flags don't typically change, this will correctly filter out keys that are not encryption capable. But, it will also skip keys whose self signature is now expired. Happily, no one appears to use signature expirations on self signatures. Since using the current time will almost never result in skipping the correct decryption key, but does protect the user from a dangerous attack, we recommend this approach when looking up a decryption key.

use sequoia_openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

let decryption_keys = cert.keys().with_policy(p, None)
    .for_storage_encryption().for_transport_encryption()
    .collect::<Vec<_>>();

[this discussion]: https://crypto.stackexchange.com/a/12138 .

pub fn bundles(self) -> KeyBundleIter<'a, P, UnspecifiedRole>[src]

Changes the iterator to return key bundles.

A key bundle is similar to a key amalgamation, but is not bound to a specific time. It contains the key and all relevant signatures.

If the primary key satisfies the current filter on this iterator, it is returned first.

pub fn subkeys(self) -> KeyBundleIter<'a, P, SubordinateRole>[src]

Changes the iterator to return subkey bundles.

A key bundle is similar to a key amalgamation, but is not bound to a specific time. It contains the key and all relevant signatures.

The primary key is never returned from this iterator.

Trait Implementations

impl<'a> Iterator for KeyIter<'a, PublicParts>[src]

type Item = KeyAmalgamation<'a, PublicParts>

The type of the elements being iterated over.

fn size_hint(&self) -> (usize, Option<usize>)
1.0.0
[src]

Returns the bounds on the remaining length of the iterator. Read more

fn count(self) -> usize
1.0.0
[src]

Consumes the iterator, counting the number of iterations and returning it. Read more

fn last(self) -> Option<Self::Item>
1.0.0
[src]

Consumes the iterator, returning the last element. Read more

fn nth(&mut self, n: usize) -> Option<Self::Item>
1.0.0
[src]

Returns the nth element of the iterator. Read more

fn step_by(self, step: usize) -> StepBy<Self>
1.28.0
[src]

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator<Item = Self::Item>, 
1.0.0
[src]

Takes two iterators and creates a new iterator over both in sequence. Read more

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator
1.0.0
[src]

'Zips up' two iterators into a single iterator of pairs. Read more

fn map<B, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> B, 
1.0.0
[src]

Takes a closure and creates an iterator which calls that closure on each element. Read more

fn for_each<F>(self, f: F) where
    F: FnMut(Self::Item), 
1.21.0
[src]

Calls a closure on each element of an iterator. Read more

fn filter<P>(self, predicate: P) -> Filter<Self, P> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Creates an iterator which uses a closure to determine if an element should be yielded. Read more

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 
1.0.0
[src]

Creates an iterator that both filters and maps. Read more

fn enumerate(self) -> Enumerate<Self>
1.0.0
[src]

Creates an iterator which gives the current iteration count as well as the next value. Read more

fn peekable(self) -> Peekable<Self>
1.0.0
[src]

Creates an iterator which can use peek to look at the next element of the iterator without consuming it. Read more

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Creates an iterator that [skip]s elements based on a predicate. Read more

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Creates an iterator that yields elements based on a predicate. Read more

fn skip(self, n: usize) -> Skip<Self>
1.0.0
[src]

Creates an iterator that skips the first n elements. Read more

fn take(self, n: usize) -> Take<Self>
1.0.0
[src]

Creates an iterator that yields its first n elements. Read more

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
    F: FnMut(&mut St, Self::Item) -> Option<B>, 
1.0.0
[src]

An iterator adaptor similar to [fold] that holds internal state and produces a new iterator. Read more

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
    F: FnMut(Self::Item) -> U,
    U: IntoIterator
1.0.0
[src]

Creates an iterator that works like map, but flattens nested structure. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoIterator
1.29.0
[src]

Creates an iterator that flattens nested structure. Read more

fn fuse(self) -> Fuse<Self>
1.0.0
[src]

Creates an iterator which ends after the first [None]. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 
1.0.0
[src]

Do something with each element of an iterator, passing the value on. Read more

fn by_ref(&mut self) -> &mut Self
1.0.0
[src]

Borrows an iterator, rather than consuming it. Read more

#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]
fn collect<B>(self) -> B where
    B: FromIterator<Self::Item>, 
1.0.0
[src]

Transforms an iterator into a collection. Read more

fn partition<B, F>(self, f: F) -> (B, B) where
    B: Default + Extend<Self::Item>,
    F: FnMut(&Self::Item) -> bool
1.0.0
[src]

Consumes an iterator, creating two collections from it. Read more

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
    F: FnMut(B, Self::Item) -> R,
    R: Try<Ok = B>, 
1.27.0
[src]

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more

fn try_for_each<F, R>(&mut self, f: F) -> R where
    F: FnMut(Self::Item) -> R,
    R: Try<Ok = ()>, 
1.27.0
[src]

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more

fn fold<B, F>(self, init: B, f: F) -> B where
    F: FnMut(B, Self::Item) -> B, 
1.0.0
[src]

An iterator method that applies a function, producing a single, final value. Read more

fn all<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool
1.0.0
[src]

Tests if every element of the iterator matches a predicate. Read more

fn any<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool
1.0.0
[src]

Tests if any element of the iterator matches a predicate. Read more

fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Searches for an element of an iterator that satisfies a predicate. Read more

fn find_map<B, F>(&mut self, f: F) -> Option<B> where
    F: FnMut(Self::Item) -> Option<B>, 
1.30.0
[src]

Applies function to the elements of iterator and returns the first non-none result. Read more

fn position<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool
1.0.0
[src]

Searches for an element in an iterator, returning its index. Read more

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool,
    Self: ExactSizeIterator + DoubleEndedIterator
1.0.0
[src]

Searches for an element in an iterator from the right, returning its index. Read more

fn max(self) -> Option<Self::Item> where
    Self::Item: Ord
1.0.0
[src]

Returns the maximum element of an iterator. Read more

fn min(self) -> Option<Self::Item> where
    Self::Item: Ord
1.0.0
[src]

Returns the minimum element of an iterator. Read more

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 
1.6.0
[src]

Returns the element that gives the maximum value from the specified function. Read more

fn max_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering
1.15.0
[src]

Returns the element that gives the maximum value with respect to the specified comparison function. Read more

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 
1.6.0
[src]

Returns the element that gives the minimum value from the specified function. Read more

fn min_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering
1.15.0
[src]

Returns the element that gives the minimum value with respect to the specified comparison function. Read more

fn rev(self) -> Rev<Self> where
    Self: DoubleEndedIterator
1.0.0
[src]

Reverses an iterator's direction. Read more

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
    FromA: Default + Extend<A>,
    FromB: Default + Extend<B>,
    Self: Iterator<Item = (A, B)>, 
1.0.0
[src]

Converts an iterator of pairs into a pair of containers. Read more

fn copied<'a, T>(self) -> Copied<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Copy
[src]

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

Creates an iterator which copies all of its elements. Read more

fn cloned<'a, T>(self) -> Cloned<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Clone
1.0.0
[src]

Creates an iterator which [clone]s all of its elements. Read more

fn cycle(self) -> Cycle<Self> where
    Self: Clone
1.0.0
[src]

Repeats an iterator endlessly. Read more

fn sum<S>(self) -> S where
    S: Sum<Self::Item>, 
1.11.0
[src]

Sums the elements of an iterator. Read more

fn product<P>(self) -> P where
    P: Product<Self::Item>, 
1.11.0
[src]

Iterates over the entire iterator, multiplying all the elements Read more

fn cmp<I>(self, other: I) -> Ordering where
    I: IntoIterator<Item = Self::Item>,
    Self::Item: Ord
1.5.0
[src]

Lexicographically compares the elements of this Iterator with those of another. Read more

fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Lexicographically compares the elements of this Iterator with those of another. Read more

fn eq<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are equal to those of another. Read more

fn ne<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are unequal to those of another. Read more

fn lt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically less than those of another. Read more

fn le<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more

fn gt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically greater than those of another. Read more

fn ge<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more

fn is_sorted(self) -> bool where
    Self::Item: PartialOrd<Self::Item>, 
[src]

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

new API

Checks if the elements of this iterator are sorted. Read more

fn is_sorted_by<F>(self, compare: F) -> bool where
    F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>, 
[src]

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

new API

Checks if the elements of this iterator are sorted using the given comparator function. Read more

fn is_sorted_by_key<F, K>(self, f: F) -> bool where
    F: FnMut(&Self::Item) -> K,
    K: PartialOrd<K>, 
[src]

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

new API

Checks if the elements of this iterator are sorted using the given key extraction function. Read more

impl<'a> Iterator for KeyIter<'a, UnspecifiedParts>[src]

type Item = KeyAmalgamation<'a, UnspecifiedParts>

The type of the elements being iterated over.

fn size_hint(&self) -> (usize, Option<usize>)
1.0.0
[src]

Returns the bounds on the remaining length of the iterator. Read more

fn count(self) -> usize
1.0.0
[src]

Consumes the iterator, counting the number of iterations and returning it. Read more

fn last(self) -> Option<Self::Item>
1.0.0
[src]

Consumes the iterator, returning the last element. Read more

fn nth(&mut self, n: usize) -> Option<Self::Item>
1.0.0
[src]

Returns the nth element of the iterator. Read more

fn step_by(self, step: usize) -> StepBy<Self>
1.28.0
[src]

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator<Item = Self::Item>, 
1.0.0
[src]

Takes two iterators and creates a new iterator over both in sequence. Read more

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator
1.0.0
[src]

'Zips up' two iterators into a single iterator of pairs. Read more

fn map<B, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> B, 
1.0.0
[src]

Takes a closure and creates an iterator which calls that closure on each element. Read more

fn for_each<F>(self, f: F) where
    F: FnMut(Self::Item), 
1.21.0
[src]

Calls a closure on each element of an iterator. Read more

fn filter<P>(self, predicate: P) -> Filter<Self, P> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Creates an iterator which uses a closure to determine if an element should be yielded. Read more

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 
1.0.0
[src]

Creates an iterator that both filters and maps. Read more

fn enumerate(self) -> Enumerate<Self>
1.0.0
[src]

Creates an iterator which gives the current iteration count as well as the next value. Read more

fn peekable(self) -> Peekable<Self>
1.0.0
[src]

Creates an iterator which can use peek to look at the next element of the iterator without consuming it. Read more

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Creates an iterator that [skip]s elements based on a predicate. Read more

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Creates an iterator that yields elements based on a predicate. Read more

fn skip(self, n: usize) -> Skip<Self>
1.0.0
[src]

Creates an iterator that skips the first n elements. Read more

fn take(self, n: usize) -> Take<Self>
1.0.0
[src]

Creates an iterator that yields its first n elements. Read more

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
    F: FnMut(&mut St, Self::Item) -> Option<B>, 
1.0.0
[src]

An iterator adaptor similar to [fold] that holds internal state and produces a new iterator. Read more

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
    F: FnMut(Self::Item) -> U,
    U: IntoIterator
1.0.0
[src]

Creates an iterator that works like map, but flattens nested structure. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoIterator
1.29.0
[src]

Creates an iterator that flattens nested structure. Read more

fn fuse(self) -> Fuse<Self>
1.0.0
[src]

Creates an iterator which ends after the first [None]. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 
1.0.0
[src]

Do something with each element of an iterator, passing the value on. Read more

fn by_ref(&mut self) -> &mut Self
1.0.0
[src]

Borrows an iterator, rather than consuming it. Read more

#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]
fn collect<B>(self) -> B where
    B: FromIterator<Self::Item>, 
1.0.0
[src]

Transforms an iterator into a collection. Read more

fn partition<B, F>(self, f: F) -> (B, B) where
    B: Default + Extend<Self::Item>,
    F: FnMut(&Self::Item) -> bool
1.0.0
[src]

Consumes an iterator, creating two collections from it. Read more

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
    F: FnMut(B, Self::Item) -> R,
    R: Try<Ok = B>, 
1.27.0
[src]

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more

fn try_for_each<F, R>(&mut self, f: F) -> R where
    F: FnMut(Self::Item) -> R,
    R: Try<Ok = ()>, 
1.27.0
[src]

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more

fn fold<B, F>(self, init: B, f: F) -> B where
    F: FnMut(B, Self::Item) -> B, 
1.0.0
[src]

An iterator method that applies a function, producing a single, final value. Read more

fn all<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool
1.0.0
[src]

Tests if every element of the iterator matches a predicate. Read more

fn any<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool
1.0.0
[src]

Tests if any element of the iterator matches a predicate. Read more

fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Searches for an element of an iterator that satisfies a predicate. Read more

fn find_map<B, F>(&mut self, f: F) -> Option<B> where
    F: FnMut(Self::Item) -> Option<B>, 
1.30.0
[src]

Applies function to the elements of iterator and returns the first non-none result. Read more

fn position<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool
1.0.0
[src]

Searches for an element in an iterator, returning its index. Read more

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool,
    Self: ExactSizeIterator + DoubleEndedIterator
1.0.0
[src]

Searches for an element in an iterator from the right, returning its index. Read more

fn max(self) -> Option<Self::Item> where
    Self::Item: Ord
1.0.0
[src]

Returns the maximum element of an iterator. Read more

fn min(self) -> Option<Self::Item> where
    Self::Item: Ord
1.0.0
[src]

Returns the minimum element of an iterator. Read more

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 
1.6.0
[src]

Returns the element that gives the maximum value from the specified function. Read more

fn max_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering
1.15.0
[src]

Returns the element that gives the maximum value with respect to the specified comparison function. Read more

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 
1.6.0
[src]

Returns the element that gives the minimum value from the specified function. Read more

fn min_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering
1.15.0
[src]

Returns the element that gives the minimum value with respect to the specified comparison function. Read more

fn rev(self) -> Rev<Self> where
    Self: DoubleEndedIterator
1.0.0
[src]

Reverses an iterator's direction. Read more

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
    FromA: Default + Extend<A>,
    FromB: Default + Extend<B>,
    Self: Iterator<Item = (A, B)>, 
1.0.0
[src]

Converts an iterator of pairs into a pair of containers. Read more

fn copied<'a, T>(self) -> Copied<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Copy
[src]

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

Creates an iterator which copies all of its elements. Read more

fn cloned<'a, T>(self) -> Cloned<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Clone
1.0.0
[src]

Creates an iterator which [clone]s all of its elements. Read more

fn cycle(self) -> Cycle<Self> where
    Self: Clone
1.0.0
[src]

Repeats an iterator endlessly. Read more

fn sum<S>(self) -> S where
    S: Sum<Self::Item>, 
1.11.0
[src]

Sums the elements of an iterator. Read more

fn product<P>(self) -> P where
    P: Product<Self::Item>, 
1.11.0
[src]

Iterates over the entire iterator, multiplying all the elements Read more

fn cmp<I>(self, other: I) -> Ordering where
    I: IntoIterator<Item = Self::Item>,
    Self::Item: Ord
1.5.0
[src]

Lexicographically compares the elements of this Iterator with those of another. Read more

fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Lexicographically compares the elements of this Iterator with those of another. Read more

fn eq<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are equal to those of another. Read more

fn ne<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are unequal to those of another. Read more

fn lt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically less than those of another. Read more

fn le<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more

fn gt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically greater than those of another. Read more

fn ge<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more

fn is_sorted(self) -> bool where
    Self::Item: PartialOrd<Self::Item>, 
[src]

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

new API

Checks if the elements of this iterator are sorted. Read more

fn is_sorted_by<F>(self, compare: F) -> bool where
    F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>, 
[src]

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

new API

Checks if the elements of this iterator are sorted using the given comparator function. Read more

fn is_sorted_by_key<F, K>(self, f: F) -> bool where
    F: FnMut(&Self::Item) -> K,
    K: PartialOrd<K>, 
[src]

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

new API

Checks if the elements of this iterator are sorted using the given key extraction function. Read more

impl<'a> Iterator for KeyIter<'a, SecretParts>[src]

type Item = KeyAmalgamation<'a, SecretParts>

The type of the elements being iterated over.

fn size_hint(&self) -> (usize, Option<usize>)
1.0.0
[src]

Returns the bounds on the remaining length of the iterator. Read more

fn count(self) -> usize
1.0.0
[src]

Consumes the iterator, counting the number of iterations and returning it. Read more

fn last(self) -> Option<Self::Item>
1.0.0
[src]

Consumes the iterator, returning the last element. Read more

fn nth(&mut self, n: usize) -> Option<Self::Item>
1.0.0
[src]

Returns the nth element of the iterator. Read more

fn step_by(self, step: usize) -> StepBy<Self>
1.28.0
[src]

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator<Item = Self::Item>, 
1.0.0
[src]

Takes two iterators and creates a new iterator over both in sequence. Read more

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator
1.0.0
[src]

'Zips up' two iterators into a single iterator of pairs. Read more

fn map<B, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> B, 
1.0.0
[src]

Takes a closure and creates an iterator which calls that closure on each element. Read more

fn for_each<F>(self, f: F) where
    F: FnMut(Self::Item), 
1.21.0
[src]

Calls a closure on each element of an iterator. Read more

fn filter<P>(self, predicate: P) -> Filter<Self, P> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Creates an iterator which uses a closure to determine if an element should be yielded. Read more

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 
1.0.0
[src]

Creates an iterator that both filters and maps. Read more

fn enumerate(self) -> Enumerate<Self>
1.0.0
[src]

Creates an iterator which gives the current iteration count as well as the next value. Read more

fn peekable(self) -> Peekable<Self>
1.0.0
[src]

Creates an iterator which can use peek to look at the next element of the iterator without consuming it. Read more

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Creates an iterator that [skip]s elements based on a predicate. Read more

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Creates an iterator that yields elements based on a predicate. Read more

fn skip(self, n: usize) -> Skip<Self>
1.0.0
[src]

Creates an iterator that skips the first n elements. Read more

fn take(self, n: usize) -> Take<Self>
1.0.0
[src]

Creates an iterator that yields its first n elements. Read more

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
    F: FnMut(&mut St, Self::Item) -> Option<B>, 
1.0.0
[src]

An iterator adaptor similar to [fold] that holds internal state and produces a new iterator. Read more

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
    F: FnMut(Self::Item) -> U,
    U: IntoIterator
1.0.0
[src]

Creates an iterator that works like map, but flattens nested structure. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoIterator
1.29.0
[src]

Creates an iterator that flattens nested structure. Read more

fn fuse(self) -> Fuse<Self>
1.0.0
[src]

Creates an iterator which ends after the first [None]. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 
1.0.0
[src]

Do something with each element of an iterator, passing the value on. Read more

fn by_ref(&mut self) -> &mut Self
1.0.0
[src]

Borrows an iterator, rather than consuming it. Read more

#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]
fn collect<B>(self) -> B where
    B: FromIterator<Self::Item>, 
1.0.0
[src]

Transforms an iterator into a collection. Read more

fn partition<B, F>(self, f: F) -> (B, B) where
    B: Default + Extend<Self::Item>,
    F: FnMut(&Self::Item) -> bool
1.0.0
[src]

Consumes an iterator, creating two collections from it. Read more

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
    F: FnMut(B, Self::Item) -> R,
    R: Try<Ok = B>, 
1.27.0
[src]

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more

fn try_for_each<F, R>(&mut self, f: F) -> R where
    F: FnMut(Self::Item) -> R,
    R: Try<Ok = ()>, 
1.27.0
[src]

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more

fn fold<B, F>(self, init: B, f: F) -> B where
    F: FnMut(B, Self::Item) -> B, 
1.0.0
[src]

An iterator method that applies a function, producing a single, final value. Read more

fn all<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool
1.0.0
[src]

Tests if every element of the iterator matches a predicate. Read more

fn any<F>(&mut self, f: F) -> bool where
    F: FnMut(Self::Item) -> bool
1.0.0
[src]

Tests if any element of the iterator matches a predicate. Read more

fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
    P: FnMut(&Self::Item) -> bool
1.0.0
[src]

Searches for an element of an iterator that satisfies a predicate. Read more

fn find_map<B, F>(&mut self, f: F) -> Option<B> where
    F: FnMut(Self::Item) -> Option<B>, 
1.30.0
[src]

Applies function to the elements of iterator and returns the first non-none result. Read more

fn position<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool
1.0.0
[src]

Searches for an element in an iterator, returning its index. Read more

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
    P: FnMut(Self::Item) -> bool,
    Self: ExactSizeIterator + DoubleEndedIterator
1.0.0
[src]

Searches for an element in an iterator from the right, returning its index. Read more

fn max(self) -> Option<Self::Item> where
    Self::Item: Ord
1.0.0
[src]

Returns the maximum element of an iterator. Read more

fn min(self) -> Option<Self::Item> where
    Self::Item: Ord
1.0.0
[src]

Returns the minimum element of an iterator. Read more

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 
1.6.0
[src]

Returns the element that gives the maximum value from the specified function. Read more

fn max_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering
1.15.0
[src]

Returns the element that gives the maximum value with respect to the specified comparison function. Read more

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
    B: Ord,
    F: FnMut(&Self::Item) -> B, 
1.6.0
[src]

Returns the element that gives the minimum value from the specified function. Read more

fn min_by<F>(self, compare: F) -> Option<Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering
1.15.0
[src]

Returns the element that gives the minimum value with respect to the specified comparison function. Read more

fn rev(self) -> Rev<Self> where
    Self: DoubleEndedIterator
1.0.0
[src]

Reverses an iterator's direction. Read more

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
    FromA: Default + Extend<A>,
    FromB: Default + Extend<B>,
    Self: Iterator<Item = (A, B)>, 
1.0.0
[src]

Converts an iterator of pairs into a pair of containers. Read more

fn copied<'a, T>(self) -> Copied<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Copy
[src]

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

Creates an iterator which copies all of its elements. Read more

fn cloned<'a, T>(self) -> Cloned<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Clone
1.0.0
[src]

Creates an iterator which [clone]s all of its elements. Read more

fn cycle(self) -> Cycle<Self> where
    Self: Clone
1.0.0
[src]

Repeats an iterator endlessly. Read more

fn sum<S>(self) -> S where
    S: Sum<Self::Item>, 
1.11.0
[src]

Sums the elements of an iterator. Read more

fn product<P>(self) -> P where
    P: Product<Self::Item>, 
1.11.0
[src]

Iterates over the entire iterator, multiplying all the elements Read more

fn cmp<I>(self, other: I) -> Ordering where
    I: IntoIterator<Item = Self::Item>,
    Self::Item: Ord
1.5.0
[src]

Lexicographically compares the elements of this Iterator with those of another. Read more

fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Lexicographically compares the elements of this Iterator with those of another. Read more

fn eq<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are equal to those of another. Read more

fn ne<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialEq<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are unequal to those of another. Read more

fn lt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically less than those of another. Read more

fn le<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more

fn gt<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically greater than those of another. Read more

fn ge<I>(self, other: I) -> bool where
    I: IntoIterator,
    Self::Item: PartialOrd<<I as IntoIterator>::Item>, 
1.5.0
[src]

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more

fn is_sorted(self) -> bool where
    Self::Item: PartialOrd<Self::Item>, 
[src]

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

new API

Checks if the elements of this iterator are sorted. Read more

fn is_sorted_by<F>(self, compare: F) -> bool where
    F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>, 
[src]

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

new API

Checks if the elements of this iterator are sorted using the given comparator function. Read more

fn is_sorted_by_key<F, K>(self, f: F) -> bool where
    F: FnMut(&Self::Item) -> K,
    K: PartialOrd<K>, 
[src]

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

new API

Checks if the elements of this iterator are sorted using the given key extraction function. Read more

impl<'a, P: KeyParts> Debug for KeyIter<'a, P>[src]

Auto Trait Implementations

impl<'a, P> Send for KeyIter<'a, P> where
    P: Send

impl<'a, P> Sync for KeyIter<'a, P> where
    P: Sync

Blanket Implementations

impl<T> From for T[src]

impl<I> IntoIterator for I where
    I: Iterator
[src]

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = I

Which kind of iterator are we turning this into?

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<I> IteratorRandom for I where
    I: Iterator
[src]

fn choose<R>(self, rng: &mut R) -> Option<Self::Item> where
    R: Rng + ?Sized
[src]

Choose one element at random from the iterator. Read more

fn choose_multiple_fill<R>(self, rng: &mut R, buf: &mut [Self::Item]) -> usize where
    R: Rng + ?Sized
[src]

Collects values at random from the iterator into a supplied buffer until that buffer is filled. Read more

fn choose_multiple<R>(self, rng: &mut R, amount: usize) -> Vec<Self::Item> where
    R: Rng + ?Sized
[src]

Collects amount values at random from the iterator into a vector. Read more

impl<V, T> VZip for T where
    V: MultiLane<T>, 

impl<I> UnicodeNormalization for I where
    I: Iterator<Item = char>,