Add some minimal documentation

This commit is contained in:
Dirkjan Ochtman 2022-02-28 11:38:50 +01:00
parent 2ef7eb82ba
commit 747dd22098
1 changed files with 2 additions and 0 deletions

View File

@ -167,6 +167,7 @@ impl<'a> SegmentState<'a> {
}
}
/// Search state for a [`Segmenter`]
#[derive(Clone, Default)]
pub struct Search {
candidates: Vec<Candidate>,
@ -218,6 +219,7 @@ impl<'a> Index<Range<usize>> for Ascii<'a> {
}
}
/// Error returned by [`Segmenter::segment`] when given an invalid character
#[derive(Debug)]
pub struct InvalidCharacter;