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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

// See https://linebender.org/blog/doc-include for this README inclusion strategy
// File links are not supported by rustdoc
//!
//! [LICENSE-APACHE]: https://github.com/robofinch/seekable-iterator/blob/main/LICENSE-APACHE
//! [LICENSE-MIT]: https://github.com/robofinch/seekable-iterator/blob/main/LICENSE-MIT
//!
//! [`PooledIterator`]: PooledIterator
//!
//! [`SeekableIterator`]: SeekableIterator
//! [`SeekableLendingIterator`]: SeekableLendingIterator
//! [`SeekablePooledIterator`]: SeekablePooledIterator
//!
//! [`CursorIterator`]: CursorIterator
//! [`CursorLendingIterator`]: CursorLendingIterator
//! [`CursorPooledIterator`]: CursorPooledIterator
//!
//! [`Seekable`]: Seekable
//! [`Comparator`]: Comparator
//! [`OrdComparator`]: OrdComparator
//!
//! [`Ord`]: Ord
//! [`FusedIterator`]: core::iter::FusedIterator
#![cfg_attr(feature = "lender", doc = " [`lender::Lender`]: lender::Lender")]
#![cfg_attr(
    feature = "lending-iterator",
    doc = " [`lending_iterator::LendingIterator`]: lending_iterator::LendingIterator",
)]
#![cfg_attr(
    feature = "alloc",
    doc = " [`MergingIter`]: merging_iter::MergingIter",
)]
#![cfg_attr(
    feature = "alloc",
    doc = " [`PooledIter`]: pooled_iter::PooledIter",
)]
#![cfg_attr(
    feature = "std",
    doc = " [`ThreadsafePooledIter`]: threadsafe_pooled_iter::ThreadsafePooledIter",
)]
//!
//! <style>
//! .rustdoc-hidden { display: none; }
//! </style>
#![cfg_attr(doc, doc = include_str!("../README.md"))]

#![cfg_attr(
    feature = "lending-iterator",
    expect(
        non_ascii_idents, clippy::disallowed_script_idents,
        reason = "`gat` uses non-ascii character",
    ),
)]

#![cfg_attr(docsrs, feature(doc_cfg))]

#![no_std]

#[cfg(feature = "alloc")]
extern crate alloc;
#[cfg(feature = "std")]
extern crate std;

mod comparator;
mod cursor;
mod pooled;
mod seekable;
mod seekable_iterators;

mod lending_iterator_support;

#[cfg(feature = "alloc")]
mod merging_iter;
#[cfg(feature = "anchored-pool")]
mod pooled_iter;
#[cfg(feature = "anchored-pool")]
mod threadsafe_pooled_iter;

#[cfg(test)]
mod test_iter;

// TODO: adapter for cursor traits and `Seekable` that applies `Borrow::borrow` to input keys.
// Note sure if it's useful though.

#[cfg(feature = "lender")]
mod lender_adapter;
#[cfg(feature = "lending-iterator")]
mod lending_iterator_adapter;


pub use self::{
    comparator::{Comparator, OrdComparator},
    cursor::{CursorIterator, CursorLendingIterator, CursorPooledIterator},
    lending_iterator_support::{ImplyBound, LendItem, LentItem},
    pooled::{OutOfBuffers, PooledIterator},
    seekable::{ItemToKey, Seekable},
    seekable_iterators::{SeekableIterator, SeekableLendingIterator, SeekablePooledIterator},
};

#[cfg(feature = "lender")]
#[cfg_attr(docsrs, doc(cfg(feature = "lender")))]
pub use self::lender_adapter::{LenderAdapter, PooledLenderAdapter};
#[cfg(feature = "lending-iterator")]
#[cfg_attr(docsrs, doc(cfg(feature = "lending-iterator")))]
pub use self::lending_iterator_adapter::{LendingIteratorAdapter, PooledLendingIteratorAdapter};

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub use self::merging_iter::MergingIter;
#[cfg(feature = "anchored-pool")]
#[cfg_attr(docsrs, doc(cfg(feature = "anchored-pool")))]
pub use self::{
    pooled_iter::{PooledIter, PoolItem},
    threadsafe_pooled_iter::{ThreadsafePooledIter, ThreadsafePoolItem},
};