Struct ParametersDir

pub struct ParametersDir { /* private fields */ }

The dir representing all of a key except for the commit id (i.e. custom parameters and target name–note that this is not the same info as RunParameters contains!).

Note that it contains env vars that may not be checked against the config. They are still guaranteed to follow the general requirements for env var names (as per AllowedEnvVar<AllowableCustomEnvVar>::from_str). Similarly, target_name may not be checked against anything (other than being a directory name).

Implementations

impl ParametersDir

pub fn base_path(&self) -> &Arc<Path>

pub fn target_name(&self) -> &ProperDirname

pub fn custom_parameters(&self) -> &CheckedOrUncheckedCustomParameters

pub fn from_job_template( base_path: Arc<Path>, job_template: &JobTemplate, ) -> Self

Trait Implementations

impl Debug for ParametersDir

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

Formats the value using the given formatter.

impl From<ParametersDir> for OutputSubdir

fn from(value: ParametersDir) -> Self

Converts to this type from the input type.

impl Ord for ParametersDir

fn cmp(&self, other: &Self) -> 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 ParametersDir

fn eq(&self, other: &Self) -> 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 ParametersDir

fn partial_cmp(&self, other: &Self) -> 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 ReplaceBasePath for ParametersDir

fn replace_base_path(&self, base_path: Arc<Path>) -> Self

impl SubDirs for ParametersDir

type Target = KeyDir

fn append_subdir_str(self: Arc<Self>, file_name: &str) -> Result<Self::Target>

fn sub_dirs( self: &Arc<Self>, ) -> Result<impl Iterator<Item = Result<Self::Target>>>

Skips non-directory entries, but requires all directory entries to be convertible to T.

impl ToPath for ParametersDir

fn to_path(&self) -> &Arc<Path>

May be slightly costly on first run but then cached in those cases

impl TryFrom<Arc<Path>> for ParametersDir

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: Arc<Path>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ParametersDir