nightrunner_lib 0.4.0

A parser library for making text adventure games
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

/// Module for the action parser. [Action]
/// are structs containing the important information
/// needed to parse the user input.
pub mod action;
pub mod errors;
/// Module with the various functions used to parse
/// the user input.
pub mod interpreter;

use self::action::Action;
use self::errors::{EmptyInput, InvalidEvent};
use self::interpreter::process_action;
use crate::config::State;
use crate::NRResult;
use crate::ParsingResult;

/// This is the main function that executes the game.
/// The `NightRunner` struct is the main entry point
/// for the library, and calls this function along with
/// the `State` struct. The return for this function is
/// a `ParsingResult` which is contains the output of
/// the game. The `ParsingResult` returned by this
/// function that is meant to be consumed by the frontend.
pub fn parse(state: &State, input: &str) -> NRResult<(State, ParsingResult)> {
    if !input.is_empty() {
        let action = Action::parse(state, input);
        match action.is_valid() {
            true => process_action(state, action),
            false => Err(InvalidEvent.into()),
        }
    } else {
        Err(EmptyInput.into())
    }
}

#[cfg(test)]
mod tests;