Struct WorktreeState 

pub struct WorktreeState {

    pub path: String,
    pub kind: WorktreeKind,
    pub standing: Standing,
    pub branch: Option<String>,
    pub label: String,
    pub head: Option<String>,
    pub detached: bool,
    pub expected_path: Option<String>,
    pub exists: bool,
    pub current: bool,
    pub locked: Option<String>,
    pub prunable: Option<String>,
    pub dirty: Option<DirtyState>,
    pub upstream: Option<UpstreamState>,
    pub issue: Option<String>,
    pub diagnostics: Vec<TopologyDiagnostic>,
}

One work tree, as the topology sees it.

Fields

path: String

Absolute, as git holds it.

kind: WorktreeKind

Primary or linked.

standing: Standing

Where it stands against the topology.

branch: Option<String>

The branch checked out here, short. Absent when detached.

label: String

The name it is shown under: the branch, or detached/<short commit>.

head: Option<String>

The commit checked out here.

detached: bool

HEAD is detached here.

expected_path: Option<String>

Where this branch’s work tree belongs. Absent when detached, or for the primary checkout on the trunk.

exists: bool

The directory git registered still exists on disk.

current: bool

The call came from inside this work tree.

locked: Option<String>

Locked, with git’s reason; an empty string when it recorded none.

prunable: Option<String>

Prunable, with git’s reason.

dirty: Option<DirtyState>

Uncommitted work here. Absent when it was not asked for: it costs one subprocess per work tree, and a topology check does not need it.

upstream: Option<UpstreamState>

The branch’s upstream and its distance from it.

issue: Option<String>

The issue this branch provably names: a path component of the branch equal to an issue id of .ai/repo/project/issues/, or beginning with it and a hyphen. Nothing is inferred from similarity.

diagnostics: Vec<TopologyDiagnostic>

What is wrong with this work tree, if anything.

Trait Implementations

impl Clone for WorktreeState

fn clone(&self) -> WorktreeState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorktreeState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorktreeState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WorktreeState

impl JsonSchema for WorktreeState

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for WorktreeState

fn eq(&self, other: &WorktreeState) -> 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 Serialize for WorktreeState

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 WorktreeState