Struct sc_service::config::BasePath

pub struct BasePath { /* private fields */ }

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

Implementations

impl BasePath

pub fn new_temp_dir() -> Result<BasePath>

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

Note: The temporary directory will be created automatically and deleted when the program exits. Every call to this function will return the same path for the lifetime of the program.

pub fn new<P: Into<PathBuf>>(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 Clone for BasePath

fn clone(&self) -> BasePath

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

Converts to this type from the input type.