documentinator 0.0.8

ROS2 documentation generator 
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

use std::fs::File;
use std::io::Read;
use std::path::PathBuf;

use anyhow::Context;
use anyhow::Result;

use crate::doc_types::Doc;
use crate::parsers::ConfigParser;

/// Parses configs from toml markup files.
#[derive(Default)]
pub struct TomlParser {}

impl ConfigParser for TomlParser {
    fn parse_str(&self, string: String) -> Result<Doc> {
        toml::from_str(&string).context("Failed to parse TOML string.")
    }

    fn parse_path(&self, path: PathBuf) -> Result<Doc> {
        let file =
            File::open(path.clone()).context(format!("Cannot open File at path {:?}", path))?;

        self.parse_file(file)
    }

    fn parse_file(&self, mut file: File) -> Result<Doc> {
        let mut string = String::new();
        file.read_to_string(&mut string)
            .context("Error while reading file".to_string())?;

        self.parse_str(string)
    }

    fn match_filename(&self, filename: &str) -> bool {
        filename.ends_with("doctor.toml")
    }
}

#[cfg(test)]
mod test {
    use crate::{ConfigParser, TomlParser};

    #[test]
    fn test_toml_parse() {
        let wld = include_str!("../../test_assets/white_line_detection.doctor.toml");
        let parser = TomlParser::default();

        parser.parse_str(wld.to_string()).unwrap();
    }
}