Struct GitButlerWorkspace 

pub struct GitButlerWorkspace {
    pub commit: ObjectId,
    pub heads: Vec<WorkspaceHead>,
}

A checked-out GitButler workspace: HEAD is on WORKSPACE_BRANCH and its tip is the workspace commit (WORKSPACE_COMMIT_MARKER in its message).

Fields

commit: ObjectId

The workspace commit at the tip of WORKSPACE_BRANCH.

heads: Vec<WorkspaceHead>

The heads merged into the workspace commit, in its parent order.

Implementations

impl GitButlerWorkspace

pub fn detect(repo: &Repository) -> Result<Option<Self>>

The workspace repo has checked out, or None when HEAD is not on one.

HEAD must be on WORKSPACE_BRANCH and that branch’s tip must be a commit whose message contains WORKSPACE_COMMIT_MARKER; a gitbutler/workspace branch with any other tip is treated as an ordinary branch.

Errors

Returns ref store and object database errors from reading HEAD, the tip commit or the local branches.

pub fn head_commits(&self) -> Vec<ObjectId>

The merged heads’ commits, in parent order: where history of the applied work starts.

Trait Implementations

impl Clone for GitButlerWorkspace

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 GitButlerWorkspace

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

Formats the value using the given formatter.

impl Eq for GitButlerWorkspace

impl PartialEq for GitButlerWorkspace

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GitButlerWorkspace