Struct oceanpkg::config::RtConfig

pub struct RtConfig {
    pub start_time: Instant,
    pub current_dir: PathBuf,
    pub user_home: PathBuf,
    pub ocean_home: LazyCell<PathBuf>,
}

Represents the configuration specific to this current instance.

This type exists so as to put creation of commonly-needed values up-front, allowing for errors only needed to be handled in one place.

Fields

start_time: Instant

The time at which the program started. Used for telling how much time has elapsed.

current_dir: PathBuf

The directory where this process was started from.

user_home: PathBuf

The current user's home directory.

ocean_home: LazyCell<PathBuf>

The directory for data stored for the current user.

Platform	Path
Linux & macOS	$HOME/.ocean
Windows	Unimplemented

Methods

impl RtConfig

pub fn create() -> Result<Self, CreateError>

Creates a new instance suitable for using at the start of your program.

pub fn create_at(start_time: Instant) -> Result<Self, CreateError>

Creates a new instance suitable for emitting metrics from start_time.

pub fn time_elapsed(&self) -> Duration

Returns the amount of time elapsed since the program started.

pub fn current_dir(&self) -> &Path

The directory where this process was started from.

pub fn ocean_home(&self) -> &Path

The directory where data for the current user is stored.

pub fn user_home(&self) -> &Path

The current user's home directory.

pub fn credentials_path(&self) -> PathBuf

Returns the path for $HOME/.ocean/credentials.toml.

pub fn bin_dir(&self) -> PathBuf

Returns the directory where binaries exposed via $PATH are stored.

pub fn cache_dir(&self) -> PathBuf

Returns Ocean's cache directory.

pub fn tarball_cache_path(&self, query: Query<&str>) -> PathBuf

Returns the path where a tarball for query should be cached.

pub fn drops_dir(&self, target: &InstallTarget) -> Cow<'static, Path>

Returns the directory where drops are installed.

Trait Implementations

impl Clone for RtConfig

fn clone(&self) -> RtConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RtConfig

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

Formats the value using the given formatter.