tweep 0.3.0

Parser for the Twee v3 interactive fiction format
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

use crate::ErrorList;
use crate::FullContext;
use crate::Output;

/// The content of a special passage with the `StoryTitle` name, which will be
/// used as the title for a parsed story
///
/// # Parse Errors
/// None
///
/// # Parse Warnings
/// None
///
/// # Examples
/// ```
/// use tweep::{FullContext, StoryTitle};
/// let context = FullContext::from(None, "Example Story".to_string());
/// let out = StoryTitle::parse(context);
/// assert_eq!(out.get_output().as_ref().ok().unwrap().title, "Example Story");
/// ```
#[derive(Debug)]
pub struct StoryTitle {
    /// The title content
    pub title: String,
}

impl StoryTitle {
    /// Parses a `StoryTitle` out of the given context
    pub fn parse(context: FullContext) -> Output<Result<Self, ErrorList>> {
        Output::new(Ok(StoryTitle {
            title: context.get_contents().to_string(),
        }))
    }
}

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

    #[test]
    fn basic() {
        let input = r#"foo
bar
baz"#
            .to_string();
        let out = StoryTitle::parse(FullContext::from(None, input.clone()));
        assert!(!out.has_warnings());
        let (res, _) = out.take();
        assert!(res.is_ok());
        let content = res.ok().unwrap();
        assert_eq!(content.title, input);
    }
}