yapcol 0.4.0

Yet Another Parser Combinator Library - YAPCoL
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

use crate::{Error, InputToken, Mismatch, Parser};

/// Creates a parser that succeeds only if the input stream is empty.
///
/// # Outcome
///
/// This parser succeeds and returns `()` if the input is empty. Otherwise, it fails with an
/// [`Error::UnexpectedToken`].
///
/// # Input consumption
///
/// This parser never consumes input tokens.
///
/// # Look-ahead and backtracking
///
/// This combinator doesn't perform any lookahead and won't backtrack upon failure.
///
/// # Examples
///
/// ```
/// use yapcol::{Error, Input, any, end_of_input};
///
/// let tokens: Vec<char> = vec![];
/// let mut input = Input::new_from_chars(tokens, None);
/// assert!(end_of_input()(&mut input).is_ok());
///
/// let tokens: Vec<char> = vec!['a', 'b'];
/// let mut input = Input::new_from_chars(tokens, None);
/// assert!(end_of_input()(&mut input).is_err());
/// assert_eq!(any()(&mut input), Ok('a')); // Input was not consumed.
/// ```
pub fn end_of_input<IT>() -> impl Parser<IT, ()>
where
	IT: InputToken,
{
	|input| match input.peek() {
		None => Ok(()),
		Some(token) => {
			let position = token.position();
			let mismatch = Mismatch::new("end of input", token.token().clone().to_string());
			Err(Error::UnexpectedToken(
				input.source_name(),
				position,
				Some(mismatch),
			))
		}
	}
}

#[cfg(test)]
mod tests {
	use crate::*;

	#[test]
	fn success() {
		let mut input = Input::new_from_chars("".chars(), None);
		assert!(end_of_input()(&mut input).is_ok());
	}

	#[test]
	fn fail() {
		let mut input = Input::new_from_chars("hello".chars(), None);
		assert!(end_of_input()(&mut input).is_err());
	}
}