Struct gix::clone::PrepareCheckout

pub struct PrepareCheckout { /* private fields */ }

Available on crate feature worktree-mutation only.

A utility to collect configuration on how to perform a checkout into a working tree, and when dropped without checking out successfully the fetched repository will be dropped.

Implementations

impl PrepareCheckout

Modification

pub fn main_worktree<P>( &mut self, progress: P, should_interrupt: &AtomicBool ) -> Result<(Repository, Outcome), Error>where P: NestedProgress, P::SubProgress: NestedProgress + 'static,

Checkout the main worktree, determining how many threads to use by looking at checkout.workers, defaulting to using on thread per logical core.

Note that this is a no-op if the remote was empty, leaving this repository empty as well. This can be validated by checking if the head() of the returned repository is not unborn.

impl PrepareCheckout

Access

pub fn repo(&self) -> &Repository

Get access to the repository while the checkout isn’t yet completed.

Panics

If the checkout is completed and the Repository was already passed on to the caller.

impl PrepareCheckout

Consumption

pub fn persist(self) -> Repository

Persist the contained repository as is even if an error may have occurred when checking out the main working tree.

Trait Implementations

impl Drop for PrepareCheckout

fn drop(&mut self)

Executes the destructor for this type.

impl From<PrepareCheckout> for Repository

fn from(prep: PrepareCheckout) -> Self

Converts to this type from the input type.