Macro pickle

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

Available on crate feature pickle only.

Implement the Pickle trait

File extension is pickle and is automatically appended.

Input

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

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	Pickle::OS_DIRECTORY	Dir	Dir::Data
$project_directory	The name of the top project folder	Pickle::PROJECT_DIRECTORY	&str	"MyProject"
$sub_directories	(Optional) sub-directories before file	Pickle::SUB_DIRECTORIES	&str	"some/dirs"
$file_name	The file name to use	Pickle::FILE_NAME	&str	"state"

Example

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

pickle!(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.pickle.