Struct WorkspaceConfig 

pub struct WorkspaceConfig { /* private fields */ }

Scope is a structure containing all of the information required for the service to operate.

Implementations

impl WorkspaceConfig

pub fn new<T>(workdir: T) -> Self

where PathBuf: From<T>,

pub fn artifacts(&self) -> &str

returns a reference to the path of the artifacts directory, as a str

pub fn application(&self) -> &str

returns the name of the application

pub fn build(&self) -> Option<&str>

returns the configured build directory

pub const fn workdir(&self) -> &PathBuf

returns a reference to the workdir PathBuf

pub fn with_artifacts<T>(self, artifacts: T) -> Self

where T: ToString,

consumes the workspace config to create another with the given artifacts directory

pub fn with_application<T>(self, application: T) -> Self

where T: ToString,

consumes the workspace config to create another with the given application name

pub fn with_build<T>(self, build: T) -> Self

where T: ToString,

consumes the workspace config to create another with the given build path

pub fn with_workdir(self, workdir: PathBuf) -> Self

consumes the workspace config to create another with the given workdir

pub fn set_artifacts<T>(&mut self, artifacts: T)

where T: ToString,

update the artifacts directory

pub fn set_application<T>(&mut self, application: T)

where T: ToString,

update the application name

pub fn set_build<T>(&mut self, build: T)

where T: ToString,

update the build path

pub fn set_current_dir(&self)

change the current directory to the workspace

pub fn set_workdir<T>(&mut self, workdir: T)

where PathBuf: From<T>,

set the working directory of the scope

pub fn set_workdir_option<T>(&mut self, workdir: Option<T>)

where PathBuf: From<T>,

if the workdir is set, set it to the given workdir

pub fn is_workdir_valid(&self) -> bool

check if the workdir is valid

pub fn path_to_application(&self) -> PathBuf

get the path to the application binary; if unspecified, the current executable is used otherwise, the path is assumed to be within the workspaces current directory.

pub fn path_to_artifacts(&self) -> PathBuf

get the path to the artifacts directory; the artifacts directory assumed to be a subdirectory of the workspace and is used to store various build artifacts, logs, temporary files, etc.

Trait Implementations

impl Clone for WorkspaceConfig

fn clone(&self) -> WorkspaceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceConfig

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

Formats the value using the given formatter.

impl Default for WorkspaceConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WorkspaceConfig

where WorkspaceConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WorkspaceConfig

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

Formats the value using the given formatter.

impl Hash for WorkspaceConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WorkspaceConfig

fn cmp(&self, other: &WorkspaceConfig) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WorkspaceConfig

fn eq(&self, other: &WorkspaceConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for WorkspaceConfig

fn partial_cmp(&self, other: &WorkspaceConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for WorkspaceConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for WorkspaceConfig

impl StructuralPartialEq for WorkspaceConfig