Enum tc_service::config::BasePath

pub enum BasePath {
    Temporary(TempDir),
    Permanenent(PathBuf),
}

The base path that is used for everything that needs to be write on disk to run a node.

Variants

Temporary(TempDir)

A temporary directory is used as base path and will be deleted when dropped.

Permanenent(PathBuf)

A path on the disk.

Implementations

impl BasePath

pub fn new_temp_dir() -> Result<BasePath>

Create a BasePath instance using a temporary directory prefixed with “tetcore” and use it as base path.

Note: the temporary directory will be created automatically and deleted when the BasePath instance is dropped.

pub fn new<P: AsRef<Path>>(path: P) -> BasePath

Create a BasePath instance based on an existing path on disk.

Note: this function will not ensure that the directory exist nor create the directory. It will also not delete the directory when the instance is dropped.

pub fn from_project(
    qualifier: &str,
    organization: &str,
    application: &str
) -> BasePath

Create a base path from values describing the project.

pub fn path(&self) -> &Path

Retrieve the base path.

pub fn config_dir(&self, chain_id: &str) -> PathBuf

Returns the configuration directory inside this base path.

The path looks like $base_path/chains/$chain_id

Trait Implementations

impl Debug for BasePath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<PathBuf> for BasePath

fn from(path: PathBuf) -> Self

Performs the conversion.