Macro bson

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

Available on crate feature bson only.

Implement the Bson trait

File extension is bson and is automatically appended.

Input

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

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

Example

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

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