Struct SkillDir 

#[non_exhaustive]
pub struct SkillDir {
    pub id: String,
    pub path: Location,
    pub requires: Option<Location>,
    pub preferred: bool,
}

A directory some tool reads skills from.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

A short, stable identifier, used by Tool to refer to it.

path: Location

Where the directory is.

requires: Option<Location>

The tool home that has to exist before this directory may be created.

None for a vendor-neutral directory, which belongs to no single tool and may be created whenever a tool that reads it is installed.

preferred: bool

Preferred when two choices are otherwise equal. Set for the vendor-neutral directory, because more tools read it.

Implementations

impl SkillDir

pub fn new(id: impl Into<String>, path: Location) -> Self

A directory at path, owned by no single tool and not preferred.

pub fn requires(self, home: Location) -> Self

The same directory, created only once home exists.

pub const fn preferred(self) -> Self

The same directory, preferred when two choices are otherwise equal.

Trait Implementations

impl Clone for SkillDir

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SkillDir

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

Formats the value using the given formatter.

impl Eq for SkillDir

impl PartialEq for SkillDir

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SkillDir