Skip to content

Commit 66cce8f

Browse files
committed
Document IndexMatchedPath
Since rust-lang/rust#19553, missing_docs checks typedefs too.
1 parent 701a7e6 commit 66cce8f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/index.rs

+5
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ pub struct IndexEntries<'a> {
2323
index: &'a Index,
2424
}
2525

26+
/// A callback function to filter index matches.
27+
///
28+
/// Used by `Index::{add_all,remove_all,update_all}`. The first argument is the
29+
/// path, and the second is the patchspec that matched it. Return 0 to confirm
30+
/// the operation on the item, > 0 to skip the item, and < 0 to abort the scan.
2631
pub type IndexMatchedPath<'a> = |&[u8], &[u8]|: 'a -> int;
2732

2833
/// A structure to represent an entry or a file inside of an index.

0 commit comments

Comments
 (0)