doc(span) Document AtEof implementation for Span.

tagua-vm · Jan 9, 2018 · 737e862 · 737e862
1 parent 983a7ba
commit 737e862
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/source/tokens.rs b/source/tokens.rs
@@ -938,6 +938,11 @@ impl<'a> InputLength for Span<'a> {
     }
 }
 
+/// Implement `AtEof` from nom to be able to use the `Span` structure
+/// as an input of the parsers.
+///
+/// This trait aims at determining whether the current span is at the
+/// end of the input.
 impl<'a> AtEof for Span<'a> {
     fn at_eof(&self) -> bool {
         self.slice.at_eof()