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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
use super::*;
impl Modinfo {
/// Create a new Modinfo instance with default values
pub fn new() -> Self {
Modinfo::default()
}
/// Write the Modinfo to a file
/// uses `modinfo_version` to determine which format to use
pub fn write(&self, file: Option<&Path>) -> Result<(), ModinfoError> {
match file {
Some(path) => {
fs::write(path, self.to_string())?;
}
None => {
fs::write(self.meta.path.clone(), self.to_string())?;
}
}
Ok(())
}
/// Retrieve the value for a given field.
///
/// Note: This is not case-sensitive so you can use `get_value_for("Author")` or `get_value_for("author")`
///
/// Please note that `version` is excluded from this function, use `get_version` instead
///
/// ```rust
/// use modinfo::Modinfo;
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_value_for("author", "Joe");
///
/// assert_eq!(modinfo.get_value_for("author"), Some(&std::borrow::Cow::from("Joe")));
/// ```
pub fn get_value_for<F>(&self, field: F) -> Option<&Cow<'_, str>>
where
F: AsRef<str>,
{
match field.as_ref().to_lowercase().as_ref() {
"author" => self.author.value.as_ref(),
"description" => self.description.value.as_ref(),
"display_name" => self.display_name.value.as_ref(),
"name" => self.name.value.as_ref(),
"website" => self.website.value.as_ref(),
"compat" => self.version.compat.as_ref(),
_ => None,
}
}
/// Set the value for a given `field` to `value`
///
/// Note: `field` is not case-sensitive, so you can use `set_value_for("Author", "Joe")` or `get_value_for("author", "Joe")`
///
/// ```rust
/// use modinfo::Modinfo;
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_value_for("name", "MyMod");
///
/// assert_eq!(modinfo.get_value_for("name"), Some(&std::borrow::Cow::from("MyMod")));
/// ```
pub fn set_value_for(&mut self, field: &str, value: &str) {
match field.to_lowercase().as_ref() {
"author" => self.author.value = Some(value.to_owned().into()),
"description" => self.description.value = Some(value.to_owned().into()),
"display_name" => self.display_name.value = Some(value.to_owned().into()),
"name" => self.name.value = Some(value.to_owned().into()),
"website" => self.website.value = Some(value.to_owned().into()),
"version" => self.version.value.set_version(value),
"compat" => self.version.compat = Some(value.to_owned().into()),
_ => (),
}
}
/// Retrieve the value for the version field included the ModInfo
///
/// Note: This is the version of the modlet, not the version of the ModInfo file format
/// Please see `get_modinfo_version` for that.
///
/// ```rust
/// use modinfo::Modinfo;
///
/// let modinfo = Modinfo::default();
///
/// assert_eq!(modinfo.get_version(), &semver::Version::new(0, 1, 0));
/// ```
pub fn get_version(&self) -> &Version {
&self.version.value
}
/// Sets the version field inside the modinfo.xml file (modlet version)
///
/// ```rust
/// use modinfo::Modinfo;
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_version("1.2.3".to_owned());
///
/// assert_eq!(modinfo.get_version(), &semver::Version::new(1, 2, 3));
/// ```
pub fn set_version(&mut self, version: String) {
self.set_value_for("version", &version)
}
/// Retrieves the current version of the ModInfo.xml file (V1 or V2)
///
/// returns a `ModinfoVersion` enum:
/// ModinfoVersion::V1
/// ModinfoVersion::V2
///
/// ```rust
/// use modinfo::{Modinfo, ModinfoVersion};
///
/// let mut modinfo = Modinfo::default();
///
/// assert_eq!(modinfo.get_modinfo_version(), ModinfoVersion::V2);
/// ```
pub fn get_modinfo_version(&self) -> ModinfoVersion {
self.meta.version
}
/// Sets the version of the ModInfo.xml file itesle (V1 or V2)
///
/// Accepts a `ModinfoVersion` enum:
/// ModinfoVersion::V1
/// ModinfoVersion::V2
///
/// ```rust
/// use modinfo::{Modinfo, ModinfoVersion};
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_modinfo_version(ModinfoVersion::V1);
///
/// assert_eq!(modinfo.get_modinfo_version(), ModinfoVersion::V1);
/// ```
pub fn set_modinfo_version(&mut self, version: ModinfoVersion) {
self.meta.version = version
}
/// Retrieves the current modinfo.xml file path
///
/// ```rust
/// use modinfo::Modinfo;
/// use std::path::PathBuf;
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_file_path(PathBuf::from("modinfo.xml"));
///
/// assert_eq!(modinfo.get_file_path(), &PathBuf::from("modinfo.xml"));
/// ```
pub fn get_file_path(&self) -> &PathBuf {
&self.meta.path
}
/// Sets the modinfo.xml file path
///
/// This is normally set automatically when a file is parsed, but can be set manually
/// such as when creating a new modinfo.xml file.
///
/// ```rust
/// use modinfo::Modinfo;
/// use std::path::PathBuf;
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_file_path(PathBuf::from("modinfo.xml"));
///
/// assert_eq!(modinfo.get_file_path(), &PathBuf::from("modinfo.xml"));
/// ```
pub fn set_file_path(&mut self, path: PathBuf) {
self.meta.path = path.clone();
}
/// Increases the Major version number by 1,
/// sets Minor and Patch to 0, and removes any pre or build data.
///
/// ```rust
/// use modinfo::Modinfo;
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_version("1.2.3-foo+bar".to_owned());
/// modinfo.bump_version_major();
///
/// assert_eq!(modinfo.get_version(), &semver::Version::new(2, 0, 0));
/// ```
pub fn bump_version_major(&mut self) {
self.version.value.bump_major()
}
/// Increases the Minor version number by 1,
/// sets Patch to 0, and removes any pre or build data.
///
/// ```rust
/// use modinfo::Modinfo;
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_version("1.2.3-foo+bar".to_owned());
/// modinfo.bump_version_minor();
///
/// assert_eq!(modinfo.get_version(), &semver::Version::new(1, 3, 0));
/// ```
pub fn bump_version_minor(&mut self) {
self.version.value.bump_minor()
}
/// Increases the Patch version number by 1,
/// and removes any pre or build data.
///
/// ```rust
/// use modinfo::Modinfo;
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_version("1.2.3-foo+bar".to_owned());
/// modinfo.bump_version_patch();
/// assert_eq!(modinfo.get_version(), &semver::Version::new(1, 2, 4));
/// ```
pub fn bump_version_patch(&mut self) {
self.version.value.bump_patch()
}
/// Adds a pre-release version to the version field
///
/// ```rust
/// use modinfo::Modinfo;
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_version("1.2.3".to_owned());
/// modinfo.add_version_pre("foo");
/// assert_eq!(modinfo.get_version(), &semver::Version::parse("1.2.3-foo").unwrap());
/// ```
pub fn add_version_pre(&mut self, pre: &str) {
self.version.value.add_pre(pre)
}
/// Adds build data to the version field
///
/// ```rust
/// use modinfo::Modinfo;
///
/// let mut modinfo = Modinfo::default();
/// modinfo.set_version("1.2.3".to_owned());
/// modinfo.add_version_build("bar");
/// assert_eq!(modinfo.get_version(), &semver::Version::parse("1.2.3+bar").unwrap());
/// ```
pub fn add_version_build(&mut self, build: &str) {
self.version.value.add_build(build)
}
}