Enum CloneError 

pub enum CloneError {
    DestNotEmpty(String),
    RemoteRefNotFound(String),
    InvalidCloneDepth,
    Library(Error),
    Remote(RemoteError),
    CheckoutFailed {
        path: PathBuf,
        commit: ObjectId,
        source: Box<Error>,
    },
}

Errors during clone.

Variants

DestNotEmpty(String)

Destination exists and is not empty.

Grit does not create or modify the destination in this case; callers must not run cleanup_failed_clone on the path.

RemoteRefNotFound(String)

Named branch or tag from CloneOptions::branch was not advertised by the remote.

InvalidCloneDepth

CloneOptions::depth was zero (git clone --depth 0 is invalid).

Library(Error)

Underlying library failure.

Remote(RemoteError)

Remote resolution or transport failure.

CheckoutFailed

Every object and ref arrived and HEAD is set, but checking out the work tree failed, for example because a partial clone could not fetch the blobs it needs.

As with Git, the repository is kept so the checkout can be retried (for example with a hard reset to HEAD); Self::should_cleanup_failed_clone is false. A checkout cancelled part way is CloneError::Library with Error::Cancelled instead, and is cleaned up like any other cancelled clone.

Fields

path: PathBuf

Destination of the clone, where the repository was kept.

commit: ObjectId

The commit the checkout was writing.

source: Box<Error>

Why the checkout failed.

Implementations

impl CloneError

pub fn should_cleanup_failed_clone(&self) -> bool

Whether cleanup_failed_clone may run after this failure.

Returns false when the destination must be left unchanged: CloneError::DestNotEmpty and pre-initialization failures such as RemoteError::InvalidRemoteName, and CloneError::CheckoutFailed, whose repository is kept.

pub fn is_remote_ref_not_found(&self) -> bool

Whether the failure is a missing -b / --branch ref (destination may be removed).

pub fn is_remote_unreadable(&self) -> bool

Whether the source could not be read at all (Error::RemoteUnreadable), as opposed to an empty remote with no branches or a local failure.

pub fn is_cancelled(&self) -> bool

Whether the clone was cancelled (Error::Cancelled).

When this returns true, Self::should_cleanup_failed_clone is also true.

pub fn kept_repository(&self) -> Option<&Path>

The repository a failed clone left in place (CloneError::CheckoutFailed).

Returns

The clone destination when the fetch and ref setup succeeded and only the checkout failed; None for every other failure.

pub fn missing_promised_object(&self) -> Option<ObjectId>

The promised object a CloneError::CheckoutFailed checkout could not get.

Returns

The first object still missing when the checkout failed on Error::PromisorFetchFailed or Error::PromisedObjectMissing (for example with lazy fetch turned off); None otherwise.

pub fn failed_promisor_remotes(&self) -> &[(String, Error)]

The promisor remotes that failed while a CloneError::CheckoutFailed checkout fetched its missing objects.

Returns

Each failing remote’s name with its first error, in the order they were tried; empty when the checkout did not fail on Error::PromisorFetchFailed.

Trait Implementations

impl Debug for CloneError

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

Formats the value using the given formatter.

impl Display for CloneError

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

Formats the value using the given formatter.

impl Error for CloneError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for CloneError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<RemoteError> for CloneError

fn from(source: RemoteError) -> Self

Converts to this type from the input type.