chomp1 0.3.4

A fast monadic-style parser combinator designed to work on stable Rust.
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

use crate::primitives::{IntoInner, Primitives};
use crate::types::{Input, ParseResult};

/// Runs the supplied parser over the input.
pub fn run_parser<I, F, T, E>(input: I, parser: F) -> (I, Result<T, E>)
where
    I: Input,
    F: FnOnce(I) -> ParseResult<I, T, E>,
{
    parser(input).into_inner()
}

/// Runs the given parser on the supplied finite input.
///
/// ```
/// use chomp1::ascii::decimal;
/// use chomp1::prelude::{parse_only, Error};
///
/// assert_eq!(parse_only(decimal, b"123foobar"), Ok(123u32));
///
/// // Annotation because `decimal` is generic over number types
/// let r: Result<u32, _> = parse_only(decimal, b"foobar");
/// assert_eq!(r, Err((&b"foobar"[..], Error::new())));
/// ```
///
/// This will not force the parser to consume all available input, any remainder
/// will be discarded. To force a parser to consume all its input, use `eof` at
/// the end like this:
///
/// ```
/// # #[macro_use] extern crate chomp1;
/// # fn main() {
/// use chomp1::prelude::{eof, parse_only, string, Error, SimpleResult, U8Input};
///
/// fn my_parser<I: U8Input>(i: I) -> SimpleResult<I, I::Buffer> {
///     parse! {i;
///         let r = string(b"pattern");
///                 eof();
///
///         ret r
///     }
/// }
///
/// assert_eq!(parse_only(my_parser, b"pattern"), Ok(&b"pattern"[..]));
/// assert_eq!(
///     parse_only(my_parser, b"pattern and more"),
///     Err((&b" and more"[..], Error::new()))
/// );
/// # }
/// ```
pub fn parse_only<'a, I, T, E, F>(parser: F, input: &'a [I]) -> Result<T, (&'a [I], E)>
where
    I: Copy + PartialEq,
    F: FnOnce(&'a [I]) -> ParseResult<&'a [I], T, E>,
{
    match parser(input).into_inner() {
        (_, Ok(t)) => Ok(t),
        (mut b, Err(e)) => Err((b.consume_remaining(), e)),
    }
}

/// Runs the given parser on the supplied string.
pub fn parse_only_str<'a, T, E, F>(parser: F, input: &'a str) -> Result<T, (&'a str, E)>
where
    F: FnOnce(&'a str) -> ParseResult<&'a str, T, E>,
{
    match parser(input).into_inner() {
        (_, Ok(t)) => Ok(t),
        (mut b, Err(e)) => Err((b.consume_remaining(), e)),
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::primitives::Primitives;
    use crate::types::Input;

    #[test]
    fn inspect_input() {
        let mut input = None;

        assert_eq!(
            parse_only(
                |i| {
                    input = Some(i.to_vec());

                    i.ret::<_, ()>("the result")
                },
                b"the input"
            ),
            Ok("the result")
        );

        assert_eq!(input, Some(b"the input".to_vec()));
    }

    #[test]
    fn err() {
        assert_eq!(
            parse_only(
                |mut i| {
                    i.consume(4);

                    i.err::<(), _>("my error")
                },
                b"the input"
            ),
            Err((&b"input"[..], "my error"))
        );
    }

    #[test]
    fn inspect_input_str() {
        let mut input = None;

        assert_eq!(
            parse_only_str(
                |i| {
                    input = Some(i.to_owned());

                    i.ret::<_, ()>("the result")
                },
                "the input"
            ),
            Ok("the result")
        );

        assert_eq!(input, Some("the input".to_owned()));
    }

    #[test]
    fn err_str() {
        assert_eq!(
            parse_only_str(
                |mut i| {
                    i.consume(4);

                    i.err::<(), _>("my error")
                },
                "the input"
            ),
            Err(("input", "my error"))
        );
    }
}