Module cuprate_helper::fs

Cuprate directories and filenames.

Environment variables on Linux

Note that this module’s functions uses dirs, which adheres to the XDG standard on Linux.

This means that the values returned by these statics may change at runtime depending on environment variables, for example:

By default the config directory is ~/.config, however if $XDG_CONFIG_HOME is set to something, that will be used instead.

std::env::set_var("XDG_CONFIG_HOME", "/custom/path");
assert_eq!(
    CUPRATE_CONFIG_DIR.to_string_lossy(),
    "/custom/path/cuprate"
);

Reference:

• https://github.com/Cuprate/cuprate/issues/46
• https://docs.rs/dirs

Constants

• CUPRATE_DIR
  Cuprate’s main directory.

Statics

• CUPRATE_BLOCKCHAIN_DIR
  Cuprate’s blockchain directory.
• CUPRATE_CACHE_DIR
  Cuprate’s cache directory.
• CUPRATE_CONFIG_DIR
  Cuprate’s config directory.
• CUPRATE_DATA_DIR
  Cuprate’s data directory.
• CUPRATE_TXPOOL_DIR
  Cuprate’s transaction pool directory.