feat!: Quest load and delete methods
- Added QuestError::TomlSerializeError variation - Added QuestError::TomlDeserializeError variation BREAKING CHANGE: Removed QuestError::TomlError variation
This commit is contained in:
parent
94d771107d
commit
86845c54a6
2 changed files with 96 additions and 4 deletions
|
|
@ -10,8 +10,10 @@ pub enum QuestError {
|
||||||
IsNotAFile(PathBuf),
|
IsNotAFile(PathBuf),
|
||||||
/// std::io::Error happenned when loading
|
/// std::io::Error happenned when loading
|
||||||
IoError(std::io::Error),
|
IoError(std::io::Error),
|
||||||
|
/// toml::ser::Error happened when loading
|
||||||
|
TomlSerializeError(toml::ser::Error),
|
||||||
/// toml::de::Error happened when loading
|
/// toml::de::Error happened when loading
|
||||||
TomlError(toml::de::Error)
|
TomlDeserializeError(toml::de::Error),
|
||||||
}
|
}
|
||||||
|
|
||||||
impl fmt::Display for QuestError {
|
impl fmt::Display for QuestError {
|
||||||
|
|
@ -19,7 +21,8 @@ impl fmt::Display for QuestError {
|
||||||
match self {
|
match self {
|
||||||
QuestError::IsNotAFile(path) => write!(f, "{:?} is not a file", path),
|
QuestError::IsNotAFile(path) => write!(f, "{:?} is not a file", path),
|
||||||
QuestError::IoError(error) => write!(f, "io error: {error}"),
|
QuestError::IoError(error) => write!(f, "io error: {error}"),
|
||||||
QuestError::TomlError(error) => write!(f, "parse error: {error}")
|
QuestError::TomlSerializeError(error) => write!(f, "serialize error: {error}"),
|
||||||
|
QuestError::TomlDeserializeError(error) => write!(f, "parse error: {error}")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
pub mod error;
|
pub mod error;
|
||||||
|
|
||||||
use std::path::PathBuf;
|
use std::{fs, io::Write, path::PathBuf};
|
||||||
|
|
||||||
use serde::{ Serialize, Deserialize };
|
use serde::{ Serialize, Deserialize };
|
||||||
use error::QuestError;
|
use error::QuestError;
|
||||||
|
|
@ -76,15 +76,104 @@ impl Default for Quest {
|
||||||
|
|
||||||
impl Quest {
|
impl Quest {
|
||||||
/// Parse quest TOML or return error
|
/// Parse quest TOML or return error
|
||||||
|
///
|
||||||
|
/// # Examples
|
||||||
|
/// ```rust
|
||||||
|
/// use squad_quest::quest::{Quest,error::QuestError};
|
||||||
|
/// # fn main() {
|
||||||
|
/// # let _ = wrapper();
|
||||||
|
/// # }
|
||||||
|
///
|
||||||
|
/// # fn wrapper() -> Result<(), QuestError> {
|
||||||
|
/// let path = "quests/0.toml".into();
|
||||||
|
///
|
||||||
|
/// let quest = Quest::load(path)?;
|
||||||
|
/// #
|
||||||
|
/// # Ok(())
|
||||||
|
/// # }
|
||||||
|
/// ```
|
||||||
pub fn load(path: PathBuf) -> Result<Self, QuestError> {
|
pub fn load(path: PathBuf) -> Result<Self, QuestError> {
|
||||||
match std::fs::read_to_string(path) {
|
match std::fs::read_to_string(path) {
|
||||||
Ok(string) => {
|
Ok(string) => {
|
||||||
match toml::from_str::<Quest>(&string) {
|
match toml::from_str::<Quest>(&string) {
|
||||||
Ok(quest) => Ok(quest),
|
Ok(quest) => Ok(quest),
|
||||||
Err(error) => Err(QuestError::TomlError(error))
|
Err(error) => Err(QuestError::TomlDeserializeError(error))
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
Err(error) => Err(QuestError::IoError(error))
|
Err(error) => Err(QuestError::IoError(error))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Check if given file is a quest, then delete it or raise an error.
|
||||||
|
/// If file is not a quest, raises [QuestError::TomlDeserializeError]
|
||||||
|
///
|
||||||
|
/// # Examples
|
||||||
|
/// ```rust
|
||||||
|
/// use squad_quest::quest::{Quest,error::QuestError};
|
||||||
|
///
|
||||||
|
/// let path = "quests/0.toml".into();
|
||||||
|
///
|
||||||
|
/// if let Err(error) = Quest::delete(path) {
|
||||||
|
/// // handle the error
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
pub fn delete(path: PathBuf) -> Result<(), QuestError> {
|
||||||
|
match Quest::load(path.clone()) {
|
||||||
|
Ok(_) => {
|
||||||
|
if let Err(error) = fs::remove_file(path) {
|
||||||
|
return Err(QuestError::IoError(error));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
},
|
||||||
|
Err(error) => Err(error)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Save quest to given folder in TOML format.
|
||||||
|
/// File will be saved as `{id}.toml`.
|
||||||
|
/// If file exists, this method will override it.
|
||||||
|
///
|
||||||
|
/// # Examples
|
||||||
|
/// ```rust
|
||||||
|
/// # fn main() {
|
||||||
|
/// use squad_quest::quest::{Quest,error::QuestError};
|
||||||
|
/// use std::path::PathBuf;
|
||||||
|
///
|
||||||
|
/// let quest = Quest::default();
|
||||||
|
///
|
||||||
|
/// let path: PathBuf = "quests".into();
|
||||||
|
/// # let path2 = path.clone();
|
||||||
|
///
|
||||||
|
/// if let Err(error) = quest.save(path) {
|
||||||
|
/// // handle the error
|
||||||
|
/// }
|
||||||
|
/// # let filename = format!("{}.toml", quest.id);
|
||||||
|
/// # let _ = Quest::delete(path2.with_file_name(filename));
|
||||||
|
/// # }
|
||||||
|
/// ```
|
||||||
|
pub fn save(&self, path: PathBuf) -> Result<(), QuestError> {
|
||||||
|
let filename = format!("{}.toml", self.id);
|
||||||
|
let full_path = path.with_file_name(filename);
|
||||||
|
|
||||||
|
let str = match toml::to_string_pretty(&self) {
|
||||||
|
Ok(string) => string,
|
||||||
|
Err(error) => {
|
||||||
|
return Err(QuestError::TomlSerializeError(error));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut file = match fs::File::create(full_path) {
|
||||||
|
Ok(f) => f,
|
||||||
|
Err(error) => {
|
||||||
|
return Err(QuestError::IoError(error));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
if let Err(error) = file.write_all(str.as_bytes()) {
|
||||||
|
return Err(QuestError::IoError(error));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue