Macro yaml

macro_rules! yaml {
    ($data:ty, $dir:expr, $project_directory:expr, $sub_directories:expr, $file_name:expr) => { ... };
}

Available on crate feature yaml only.

Implement the Yaml trait

File extension is yml and is automatically appended.

Input

These are the inputs you need to provide to implement Yaml.

Variable	Description	Related Trait Constant	Type	Example
$data	Identifier of the data to implement for		struct or enum	MyState
$dir	Which OS directory to use	Yaml::OS_DIRECTORY	Dir	Dir::Data
$project_directory	The name of the top project folder	Yaml::PROJECT_DIRECTORY	&str	"MyProject"
$sub_directories	(Optional) sub-directories before file	Yaml::SUB_DIRECTORIES	&str	"some/dirs"
$file_name	The file name to use	Yaml::FILE_NAME	&str	"state"

Example

use serde::{Serialize,Deserialize};
use disk::*;

yaml!(State, Dir::Data, "MyProject", "some/dirs", "state");
#[derive(Serialize,Deserialize)]
struct State {
    string: String,
    number: u32,
}

This example would be located at ~/.local/share/myproject/some/dirs/state.yml.