Struct BranchState 

pub struct BranchState {
    pub name: String,
    pub head: String,
    pub trunk: bool,
    pub expected_path: Option<String>,
    pub worktree: Option<String>,
    pub upstream: Option<UpstreamState>,
    pub merged_into_trunk: Option<bool>,
    pub cleanup_eligible: bool,
    pub issue: Option<String>,
}

One local branch, with or without a work tree.

Fields

name: String

The branch, short.

head: String

The commit it points at.

trunk: bool

This branch is the trunk.

expected_path: Option<String>

Where its work tree belongs.

worktree: Option<String>

Where it is checked out, when it is.

upstream: Option<UpstreamState>

The upstream and its distance.

merged_into_trunk: Option<bool>

Reachable from the trunk. Absent when the trunk is unknown.

cleanup_eligible: bool

Merged into the trunk, not the trunk, and either not checked out or checked out in a work tree known to be clean. Derived state, never acted on automatically.

issue: Option<String>

The issue this branch provably names.

Trait Implementations

impl Clone for BranchState

fn clone(&self) -> BranchState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BranchState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BranchState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BranchState

impl JsonSchema for BranchState

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 Ordered for BranchState

A branch state is the branch it describes, ordered by the same name, so the topology listing and the trace listing read in the same sequence.

fn order_key(&self) -> OrderKey<'_>

The four parts this item is ordered by. Borrowed from the item: building a key allocates nothing, so sorting a large collection costs the comparisons and no more.

impl PartialEq for BranchState

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

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 BranchState