Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/windirstat/walkdir.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYufeng Wang <yufengwang05@gmail.com>2017-06-29 03:59:25 +0300
committerAndrew Gallant <jamslam@gmail.com>2017-06-29 16:34:54 +0300
commit92cec6508689df0b5b2cadb6614c86789f8e48ff (patch)
tree06ab057db7100d638548843d2882cdd289327c4b
parentdbc7827237f39074882c2b97d916f1af0f0ad977 (diff)
add links to IntoIter and FilterEntry docs
-rw-r--r--src/lib.rs9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/lib.rs b/src/lib.rs
index b38544d..e1f3664 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -342,11 +342,13 @@ impl IntoIterator for WalkDir {
/// An iterator for recursively descending into a directory.
///
-/// A value with this type must be constructed with the `WalkDir` type, which
+/// A value with this type must be constructed with the [`WalkDir`] type, which
/// uses a builder pattern to set options such as min/max depth, max open file
/// descriptors and whether the iterator should follow symbolic links.
///
/// The order of elements yielded by this iterator is unspecified.
+///
+/// [`WalkDir`]: struct.WalkDir.html
pub struct IntoIter {
/// Options specified in the builder. Depths, max fds, etc.
opts: WalkDirOptions,
@@ -868,7 +870,7 @@ impl fmt::Debug for DirEntry {
/// Directories that fail the predicate `P` are skipped. Namely, they are
/// never yielded and never descended into.
///
-/// Entries that are skipped with the `min_depth` and `max_depth` options are
+/// Entries that are skipped with the [`min_depth`] and [`max_depth`] options are
/// not passed through this filter.
///
/// If opening a handle to a directory resulted in an error, then it is yielded
@@ -876,6 +878,9 @@ impl fmt::Debug for DirEntry {
///
/// Type parameter `I` refers to the underlying iterator and `P` refers to the
/// predicate, which is usually `FnMut(&DirEntry) -> bool`.
+///
+/// [`min_depth`]: struct.WalkDir.html#method.min_depth
+/// [`max_depth`]: struct.WalkDir.html#method.max_depth
pub struct FilterEntry<I, P> {
it: I,
predicate: P,