merlon 1.3.1

Mod package manager for the Paper Mario (N64) decompilation
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

use std::str::FromStr;
use std::fmt;
use heck::AsKebabCase;
use thiserror::Error;
use serde::{Deserialize, Serialize};
use pyo3::prelude::*;

/// A validated package name.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(transparent)]
pub struct Name(String);

/// Errors that can occur when validating a package name.
#[derive(Error, Debug)]
pub enum Error {
    /// Package name is empty.
    #[error("package name cannot be empty")]
    Empty,

    /// Package name contains a forward slash.
    #[error("package name cannot contain '/'")]
    ContainsSlash,

    /// Package name is multiple lines (contains a newline character).
    #[error("package name must be single line")]
    ContainsNewline,
}

mod python_exception {
    #![allow(missing_docs)]
    pyo3::create_exception!(merlon, NameError, pyo3::exceptions::PyValueError);
}

/// Package validation result type alias.
pub type Result<T> = std::result::Result<T, Error>;

/// Trait alias for TryInto<Name, Error = Error>
pub trait TryIntoName {
    /// Try to convert into a package name.
    fn try_into_name(self) -> Result<Name>;
}

impl<T: TryInto<Name, Error=Error>> TryIntoName for T {
    fn try_into_name(self) -> Result<Name> {
        self.try_into()
    }
}

impl TryIntoName for Name {
    fn try_into_name(self) -> Result<Name> {
        Ok(self)
    }
}

impl Name {
    /// Creates a new name from a string.
    pub fn new(name: String) -> Result<Self> {
        if name.is_empty() { 
            return Err(Error::Empty);
        }
        if name.contains('/') {
            return Err(Error::ContainsSlash);
        }
        if name.contains('\n') {
            return Err(Error::ContainsNewline);
        }
        Ok(Self(name))
    }

    /// Returns the name as kebab-case.
    pub fn as_kebab_case(&self) -> String {
        format!("{}", AsKebabCase(&self.0))
    }
}

impl fmt::Display for Name {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl FromStr for Name {
    type Err = Error;
    fn from_str(s: &str) -> Result<Self> {
        Self::new(s.to_owned())
    }
}

impl TryFrom<String> for Name {
    type Error = Error;
    fn try_from(value: String) -> Result<Self> {
        Self::new(value)
    }
}

impl TryFrom<&str> for Name {
    type Error = Error;
    fn try_from(value: &str) -> Result<Self> {
        Self::new(value.to_owned())
    }
}

impl FromPyObject<'_> for Name {
    fn extract(ob: &PyAny) -> PyResult<Self> {
        let s: String = ob.extract()?;
        Self::new(s).map_err(|e| python_exception::NameError::new_err(e.to_string()))
    }
}

impl ToPyObject for Name {
    fn to_object(&self, py: Python) -> PyObject {
        self.0.to_object(py)
    }
}

impl IntoPy<PyObject> for Name {
    fn into_py(self, py: Python) -> PyObject {
        self.0.into_py(py)
    }
}