elyze 1.5.5

Elyze is an extensible general purpose framework parser allowing to parser any type of data without allocation.
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

//! A helper type for scanning and accepting values.

use crate::errors::{ParseError, ParseResult};
use crate::scanner::Scanner;
use crate::visitor::Visitor;

/// A type that wraps a `Scanner` and holds a successfully accepted value.
///
/// When a value is successfully accepted, the `Acceptor` stores the value in its
/// `data` field and returns itself. If a value is not accepted, the `Acceptor`
/// rewinds the scanner to the previous position and returns itself.
///
/// # Type Parameters
///
/// * `T` - The type of the data to scan.
/// * `V` - The type of the value to accept.
/// * `'a` - The lifetime of the data to scan.
/// * `'b` - The lifetime of the acceptor.
#[derive(Debug)]
pub struct Acceptor<'a, 'b, T, V> {
    /// The accepted value, if any.
    data: Option<V>,
    /// The scanner to use when consuming input.
    scanner: &'b mut Scanner<'a, T>,
}

impl<'a, 'b, T, V> Acceptor<'a, 'b, T, V> {
    /// Create a new acceptor.
    ///
    /// # Arguments
    ///
    /// * `scanner` - The scanner to use when consuming input.
    ///
    /// # Returns
    ///
    /// A new acceptor that uses the given scanner.
    pub fn new(scanner: &'b mut Scanner<'a, T>) -> Acceptor<'a, 'b, T, V> {
        Acceptor {
            data: None,
            scanner,
        }
    }
}

impl<'a, T, V> Acceptor<'a, '_, T, V> {
    /// Attempt to accept a `U` using the given `transformer`, and rewind the scanner
    /// and return the current acceptor if it fails.
    ///
    /// # Arguments
    ///
    /// * `transformer` - A function that takes a `U` and returns a `ParseResult<V>`.
    ///
    /// # Returns
    ///
    /// If the `U` is successfully accepted and the `transformer` returns `Ok`, returns
    /// the current acceptor with the resulting value in `data`. If the `U` is not
    /// successfully accepted, returns the current acceptor with the current position
    /// of the scanner rewound to the position at which the `U` was attempted, and
    /// `data` is left `None`.
    pub fn try_or<U: Visitor<'a, T>, F>(mut self, transformer: F) -> ParseResult<Self>
    where
        F: Fn(U) -> V,
    {
        let cursor = self.scanner.current_position();
        // Propagate the data
        if self.data.is_some() {
            return Ok(self);
        }

        match U::accept(self.scanner) {
            Ok(found) => {
                self.data = Some(transformer(found));
            }
            Err(ParseError::UnexpectedToken | ParseError::UnexpectedEndOfInput) => {
                self.scanner.jump_to(cursor);
            }
            Err(err) => {
                return Err(err);
            }
        }

        Ok(self)
    }

    /// Consume the acceptor and return the `V` that was accepted if the acceptor was
    /// successful.
    ///
    /// # Returns
    ///
    /// If the acceptor was successful (i.e., `data` is `Some`), returns the `V` that
    /// was accepted. Otherwise, returns `None`.
    pub fn finish(self) -> Option<V> {
        self.data
    }
}