Trait disk::Bincode

source ·

pub unsafe trait Bincode: Serialize + DeserializeOwned {
    const OS_DIRECTORY: Dir;
    const PROJECT_DIRECTORY: &'static str;
    const SUB_DIRECTORIES: &'static str;
    const FILE: &'static str;
    const FILE_EXT: &'static str;
    const FILE_NAME: &'static str;
    const FILE_NAME_GZIP: &'static str;
    const FILE_NAME_TMP: &'static str;
    const FILE_NAME_GZIP_TMP: &'static str;
    const HEADER: [u8; 24];
    const VERSION: u8;
Show 34 methods
    // Provided methods
    fn mkdir() -> Result<(), Error> { ... }
    fn rm_rf() -> Result<(), Error> { ... }
    fn rm() -> Result<(), Error> { ... }
    fn exists() -> Result<bool, Error> { ... }
    fn project_dir() -> &'static str { ... }
    fn sub_dirs() -> &'static str { ... }
    fn file_name() -> &'static str { ... }
    fn file_ext() -> &'static str { ... }
    fn file() -> &'static str { ... }
    fn file_gzip() -> &'static str { ... }
    fn file_tmp() -> &'static str { ... }
    fn file_gzip_tmp() -> &'static str { ... }
    fn base_path() -> Result<PathBuf, Error> { ... }
    fn absolute_path() -> Result<PathBuf, Error> { ... }
    fn read_to_bytes() -> Result<Vec<u8>, Error> { ... }
    fn read_to_bytes_gzip() -> Result<Vec<u8>, Error> { ... }
    fn exists_gzip() -> Result<bool, Error> { ... }
    fn from_file() -> Result<Self, Error> { ... }
    fn from_file_gzip() -> Result<Self, Error> { ... }
    fn save(&self) -> Result<(), Error> { ... }
    fn save_gzip(&self) -> Result<(), Error> { ... }
    fn save_atomic(&self) -> Result<(), Error> { ... }
    fn save_atomic_gzip(&self) -> Result<(), Error> { ... }
    fn rm_atomic(&self) -> Result<(), Error> { ... }
    fn rm_atomic_gzip(&self) -> Result<(), Error> { ... }
    fn rm_tmp() -> Result<(), Error> { ... }
    fn absolute_path_gzip() -> Result<PathBuf, Error> { ... }
    fn into_writable_fmt(&self) -> Result<Vec<u8>, Error> { ... }
    fn from_bytes(bytes: &[u8]) -> Result<Self, Error> { ... }
    fn to_bytes(&self) -> Result<Vec<u8>, Error> { ... }
    fn header_version_bytes(&self) -> [u8; 25] { ... }
    fn file_header_to_string(&self) -> Result<String, Error> { ... }
    fn file_version() -> Result<u8, Error> { ... }
    fn file_bytes(range: Range<u16>) -> Result<Vec<u8>, Error> { ... }
}

Expand description

Bincode (binary) file format

Encoding

The encoding options used is:

bincode::DefaultOptions::new().with_varint_encoding();

File extension is .bin.

Safety

When manually implementing, you are promising that the PATH’s manually specified are correct.

Required Associated Constants§

source

const OS_DIRECTORY: Dir

Which OS directory it will be saved in.

source

const PROJECT_DIRECTORY: &'static str

What the main project directory will be.

source

const SUB_DIRECTORIES: &'static str

Optional sub directories in between the project directory and file.

source

const FILE: &'static str

What the raw file name will be (no extension).

source

const FILE_EXT: &'static str

What the file extension will be.

source

const FILE_NAME: &'static str

What the full filename + extension will be.

source

const FILE_NAME_GZIP: &'static str

What the gzip variant of the filename will be.

source

const FILE_NAME_TMP: &'static str

What the tmp variant of the filename will be.

source

const FILE_NAME_GZIP_TMP: &'static str

What the gzip + tmp variant of the filename will be.

A custom 24-byte length identifying header for your Bincode file.

This is combined with Self::VERSION to prefix your file with 25 bytes.

Note: Self::save_gzip() applies compression AFTER, meaning the entire file must be decompressed to get these headers.

source

const VERSION: u8

What the version byte will be (0-255).

Provided Methods§

source

fn mkdir() -> Result<(), Error>

Create the directories leading up-to the file.

This is not necessary when using any variant of Self::save() as the directories are created implicitly.

source

fn rm_rf() -> Result<(), Error>

Recursively remove this file’s project directory.

This deletes all directories starting from Self::PROJECT_DIRECTORY. For example:

disk::toml!(State, disk::Dir::Data, "MyProject", "sub_dir", "state");

This project’s file would be located at ~/.local/share/myproject. This is the PATH that gets removed recursively.

This is akin to running:

rm -rf ~/.local/share/myproject

The input to all disk macros are sanity checked. The worst you can do with this function is delete your project’s directory.

This function calls std::fs::remove_dir_all, which does not follow symlinks.

source

fn rm() -> Result<(), Error>

Try deleting the file.

This will return success if the file doesn’t exist or if deleted.

It will return failure if the file existed but could not be deleted or if any other error occurs.

source

fn exists() -> Result<bool, Error>

Check if the file exists.

true == The file exists.
false == The file does not exist.
anyhow::Error == There was an error, existance is unknown.

source