seekable-iterator 0.4.0

Traits for iterators and lending iterators with seeking capabilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

use crate::{comparator::Comparator, seekable::Seekable};
use crate::cursor::{CursorIterator, CursorLendingIterator, CursorPooledIterator};


/// An [`Iterator`] with cursor methods from [`CursorIterator`] and the ability to seek from
/// [`Seekable`].
///
/// See [`CursorIterator`] for more.
///
/// All implementations are automatically provided by a blanket impl.
pub trait SeekableIterator<Key, Cmp>: CursorIterator + Seekable<Key, Cmp>
where
    Key: ?Sized,
    Cmp: ?Sized + Comparator<Key>,
{}

impl<Key, Cmp, I> SeekableIterator<Key, Cmp> for I
where
    Key: ?Sized,
    Cmp: ?Sized + Comparator<Key>,
    I: CursorIterator + Seekable<Key, Cmp>,
{}

/// A lending iterator with cursor methods from [`CursorLendingIterator`] and the ability to seek
/// from [`Seekable`].
///
/// As a lending iterator, only one entry can be accessed at a time.
///
/// See [`CursorLendingIterator`] for more.
///
/// All implementations are automatically provided by a blanket impl.
///
/// # Note
/// Types which implement [`SeekableLendingIterator`] should strongly consider implementing
/// [`ItemToKey`] as well.
///
/// [`ItemToKey`]: crate::seekable::ItemToKey
pub trait SeekableLendingIterator<Key, Cmp>: CursorLendingIterator + Seekable<Key, Cmp>
where
    Key: ?Sized,
    Cmp: ?Sized + Comparator<Key>,
{}

impl<Key, Cmp, I> SeekableLendingIterator<Key, Cmp> for I
where
    Key: ?Sized,
    Cmp: ?Sized + Comparator<Key>,
    I: CursorLendingIterator + Seekable<Key, Cmp>,
{}

/// A [`PooledIterator`] with cursor methods from [`CursorPooledIterator`] and the ability
/// to seek from [`Seekable`].
///
/// The iterator is similar to a lending iterator (which can lend one item at a time), but can
/// make use of a buffer pool to lend out multiple items at a time.
///
/// See [`CursorPooledIterator`] for more.
///
/// All implementations are automatically provided by a blanket impl.
///
/// [`PooledIterator`]: crate::pooled::PooledIterator
pub trait SeekablePooledIterator<Key, Cmp>: CursorPooledIterator + Seekable<Key, Cmp>
where
    Key: ?Sized,
    Cmp: ?Sized + Comparator<Key>,
{}

impl<Key, Cmp, I> SeekablePooledIterator<Key, Cmp> for I
where
    Key: ?Sized,
    Cmp: ?Sized + Comparator<Key>,
    I: CursorPooledIterator + Seekable<Key, Cmp>,
{}