Enum ProjectLocation 

pub enum ProjectLocation {
    Tracked {
        path: Utf8PathBuf,
        source: PathSource,
    },
    Untracked {
        path: Utf8PathBuf,
        source: PathSource,
    },
    External {
        path: Utf8PathBuf,
        source: PathSource,
    },
    Env {
        variable: &'static str,
        value: Option<String>,
    },
    None,
}

Where a location the project owns actually sits.

The four absent-looking cases are not one case. A repository-relative directory is checkable from a fresh clone. A directory outside the repository is not, and neither is one a variable resolves at run time, and a project that keeps none promises nothing at all.

Variants

Tracked

A repository-relative directory under version control.

Fields

path: Utf8PathBuf

Where it sits, relative to the instance root.

source: PathSource

What decided it.

Untracked

A repository-relative directory version control does not carry.

Fields

path: Utf8PathBuf

Where it sits, relative to the instance root.

source: PathSource

What decided it.

External

A directory outside the repository.

Fields

path: Utf8PathBuf

Where it sits, as the record carries it.

source: PathSource

What decided it.

Env

Wherever a variable resolves at run time.

Fields

variable: &'static str

The variable that carries it.

value: Option<String>

What that variable carries here, when it is set.

None

The project keeps none.

Trait Implementations

impl Clone for ProjectLocation

fn clone(&self) -> ProjectLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectLocation

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

Formats the value using the given formatter.

impl Eq for ProjectLocation

impl PartialEq for ProjectLocation

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProjectLocation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ProjectLocation