Skip to main content

Workspace

worktree_io::workspace

Struct Workspace 

Source 
pub struct Workspace {
    pub path: PathBuf,
    pub issue: IssueRef,
    pub created: bool,
}
Expand description

An open (or newly created) git worktree for a given issue.

Fields§

§path: PathBuf

Absolute path to the worktree directory.

§issue: IssueRef

The issue this workspace was opened for.

§created: bool

true if this call created the worktree; false if it already existed.

Implementations§

Source§

impl Workspace

Source

pub fn open_or_create(issue: IssueRef) -> Result<Self>

Open an existing worktree or create a fresh one.

§Errors

Returns an error if the repository cannot be cloned/fetched, the branch cannot be detected, or the worktree cannot be created.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.