Enum PlanZone 

pub enum PlanZone {
    Tracked {
        path: Utf8PathBuf,
    },
    Untracked {
        path: Utf8PathBuf,
    },
    Env,
    None,
}

Where the project’s planning tool writes its entry documents.

The kind is part of the value because the three absent cases are not one case. A tracked zone is a directory every clone has, so a command may check it and an absent directory is drift. An untracked zone and a zone reached through PLAN_ZONE_VAR are absent on a fresh clone, so the same failure there would report a layout the project never promised.

Variants

Tracked

A repository-relative directory under version control.

Fields

path: Utf8PathBuf

Where the zone sits, relative to the instance root.

Untracked

A repository-relative directory version control does not carry.

Fields

path: Utf8PathBuf

Where the zone sits, relative to the instance root.

Env

Wherever PLAN_ZONE_VAR resolves at run time.

None

The project keeps no plan zone.

Implementations

impl PlanZone

pub fn parse(value: &str) -> Result<Self, DeclaredPathError>

Read the --plan-zone argument’s four forms.

none and env are words rather than paths, so a directory with either name is written ./none or ./env.

Errors

DeclaredPathError for a path that is empty, absolute, or leaves the repository.

pub const fn path(&self) -> Option<&Utf8PathBuf>

The recorded path, whatever the kind carries.

Trait Implementations

impl Clone for PlanZone

fn clone(&self) -> PlanZone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlanZone

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

Formats the value using the given formatter.

impl Default for PlanZone

fn default() -> PlanZone

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PlanZone

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PlanZone

impl PartialEq for PlanZone

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PlanZone

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 PlanZone