yapcol 0.3.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

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

/// A simple combinator that returns the next token in the input, if any.
///
/// # Outcome
///
/// This combinator succeeds if at least 1 token is available on the input. It fails only if the
/// input was exhausted (i.e., empty, there are no more tokens on the input).
///
/// # Input consumption
///
/// This combinator consumes exactly 1 token if it succeeds. It doesn't consume input if it fails.
///
/// # Look-ahead and backtracking
///
/// This combinator doesn't perform any lookahead and won't backtrack upon failure.
///
/// # Examples
///
/// ```
/// use yapcol::any;
/// use yapcol::input::Input;
///
/// // An example input iterator
/// let mut input = Input::new_from_chars("123".chars(), None);
/// let output = any()(&mut input);
/// assert_eq!(output, Ok('1'));
/// ```
pub fn any<IT>() -> impl Parser<IT, IT::Token>
where
	IT: InputToken,
{
	|input| match input.next_token() {
		Some(input_token) => Ok(input_token.token_owned()),
		None => Err(Error::EndOfInput(None)),
	}
}

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

	#[test]
	fn empty() {
		let mut input = Input::new_from_chars("".chars(), None);
		let output = any()(&mut input);
		assert_eq!(output, Err(Error::EndOfInput(None)));
	}

	#[test]
	fn success() {
		let mut input = Input::new_from_chars("abc".chars(), None);
		let output = any()(&mut input);
		assert_eq!(output, Ok('a'));
		// Using it twice returns the second token.
		let output = any()(&mut input);
		assert_eq!(output, Ok('b'));
	}
}