Skip to main content

RefError

Enum RefError 

Source
#[non_exhaustive]
pub enum RefError {
Show 18 variants Invalid { detail: String, }, PackedRefsUnexpectedLine { path: String, line: String, }, Lock(RefLockError), Store(RefStoreError), Reftable(ReftableError), DetachedHead, UnbornHead, InvalidHead, HeadNotOnBranch { branch: String, }, HeadNotDetached, LockReleased { refname: String, }, QueryNeedsObjectDatabase, QueryTargetNotCommit { oid: ObjectId, }, ReflogUnknownRef { refname: String, }, ReflogInvalidSelector { spec: String, }, ReflogInvalidIndex { spec: String, source: ParseIntError, }, InvalidReflogExpiry { value: String, }, ReflogIndexOutOfRange { refname: String, index: usize, },
}
Expand description

Reference failure: ref names and values, packed-refs, ref locks, ref stores (files and reftable), reflog selectors, and the state of HEAD.

Surfaced on the umbrella as Error::Ref. Branch and tag porcelain failures have their own areas (Error::Branch, Error::Tag).

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Invalid

A reference name or value is invalid.

Fields

§detail: String

What is wrong with the ref name or value.

§

PackedRefsUnexpectedLine

A packed-refs line Git would reject when reading the ref database.

Fields

§path: String

Path to the packed-refs file being read.

§line: String

Offending line contents.

§

Lock(RefLockError)

Reference lock failure while updating refs.

§

Store(RefStoreError)

Reference store transaction or iteration failure.

§

Reftable(ReftableError)

Reftable file, stack, or transaction failure.

§

DetachedHead

create_commit requires a branch checkout.

§

UnbornHead

HEAD is on a branch with no commits yet, but the operation needs a commit (Repository::head_commit, replay_commit).

§

InvalidHead

HEAD could not be resolved to a branch, detached commit, or unborn branch.

§

HeadNotOnBranch

HEAD is not a symbolic ref to the branch an update expected it to be on.

Fields

§branch: String

Full name of the branch HEAD was expected to point at.

§

HeadNotDetached

A detached-HEAD update found HEAD attached to a branch.

§

LockReleased

A ref update tried to write through a lock it had already committed or dropped.

Fields

§refname: String

The ref whose lock was released.

§

QueryNeedsObjectDatabase

A ref query sorted by creator date, or filtered by reachability, without an object database to read commits from.

§

QueryTargetNotCommit

A ref query’s --contains / --merged / --no-merged target does not peel to a commit.

Fields

§oid: ObjectId

The target object.

§

ReflogUnknownRef

Ref does not exist and has no reflog entries.

Fields

§refname: String

User-supplied or DWIM ref name.

§

ReflogInvalidSelector

A reflog selector is missing its reference or @{n} delimiters.

Fields

§spec: String

Selector after trimming surrounding whitespace.

§

ReflogInvalidIndex

A reflog selector index is not a nonnegative integer that fits in usize.

Fields

§spec: String

Selector after trimming surrounding whitespace.

§source: ParseIntError

Integer parsing failure, including overflow.

§

InvalidReflogExpiry

A reflog expiry (gc.reflogExpire, --expire) is neither never/now/all nor a date.

Fields

§value: String

The expiry as given.

§

ReflogIndexOutOfRange

ref@{{n}} is out of range for the current reflog.

Fields

§refname: String

Ref whose reflog was read.

§index: usize

Requested newest-first index.

Implementations§

Source§

impl RefError

Source

pub fn kind_name(&self) -> &'static str

Stable snake_case slug for this failure (the former umbrella variant names).

Trait Implementations§

Source§

impl Debug for RefError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for RefError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for RefError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<RefError> for Error

Source§

fn from(source: RefError) -> Self

Converts to this type from the input type.
Source§

impl From<RefLockError> for RefError

Source§

fn from(source: RefLockError) -> Self

Converts to this type from the input type.
Source§

impl From<ReftableError> for RefError

Source§

fn from(source: ReftableError) -> Self

Converts to this type from the input type.

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.