sphinx_inv 0.2.0

A rust library to parse Sphinx `objects.inv` files
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

use std::{fmt::Display, str::FromStr};

use winnow::{
    ModalResult, Parser,
    error::{ContextError, StrContext},
    stream::AsChar,
    token::take_till,
};

use crate::SphinxType;

#[derive(Debug, PartialEq)]
pub enum CmakeRole {
    Command,
    CpackGen,
    Envvar,
    Generator,
    Genex,
    Guide,
    Manual,
    Module,
    Policy,
    PropCache,
    PropDir,
    PropGbl,
    PropInst,
    PropSf,
    PropTest,
    PropTgt,
    Variable,
}

impl Display for CmakeRole {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(match self {
            CmakeRole::Command => "command",
            CmakeRole::CpackGen => "cpack_gen",
            CmakeRole::Envvar => "envvar",
            CmakeRole::Generator => "generator",
            CmakeRole::Genex => "genex",
            CmakeRole::Guide => "guide",
            CmakeRole::Manual => "manual",
            CmakeRole::Module => "module",
            CmakeRole::Policy => "policy",
            CmakeRole::PropCache => "prop_cache",
            CmakeRole::PropDir => "prop_dir",
            CmakeRole::PropGbl => "prop_gbl",
            CmakeRole::PropInst => "prop_inst",
            CmakeRole::PropSf => "prop_sf",
            CmakeRole::PropTest => "prop_test",
            CmakeRole::PropTgt => "prop_tgt",
            CmakeRole::Variable => "variable",
        })
    }
}

/// Parses a cpp role as defined in [`HttpRole`]
/// may not contain whitespace but may contain other colons
pub(crate) fn cmake_role(input: &mut &str) -> ModalResult<SphinxType> {
    let role = take_till(1.., AsChar::is_space)
        .context(StrContext::Label("cmake role"))
        .parse_to::<CmakeRole>()
        .parse_next(input)?;
    Ok(SphinxType::Cmake(role))
}
impl FromStr for CmakeRole {
    type Err = ContextError;

    fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
        match s {
            "command" => Ok(CmakeRole::Command),
            "cpack_gen" => Ok(CmakeRole::CpackGen),
            "envvar" => Ok(CmakeRole::Envvar),
            "generator" => Ok(CmakeRole::Generator),
            "genex" => Ok(CmakeRole::Genex),
            "guide" => Ok(CmakeRole::Guide),
            "manual" => Ok(CmakeRole::Manual),
            "module" => Ok(CmakeRole::Module),
            "policy" => Ok(CmakeRole::Policy),
            "prop_cache" => Ok(CmakeRole::PropCache),
            "prop_dir" => Ok(CmakeRole::PropDir),
            "prop_gbl" => Ok(CmakeRole::PropGbl),
            "prop_inst" => Ok(CmakeRole::PropInst),
            "prop_sf" => Ok(CmakeRole::PropSf),
            "prop_test" => Ok(CmakeRole::PropTest),
            "prop_tgt" => Ok(CmakeRole::PropTgt),
            "variable" => Ok(CmakeRole::Variable),

            _ => Err(ContextError::new()),
        }
    }
}