Struct git2::Error

pub struct Error { /* fields omitted */ }

A structure to represent errors coming out of libgit2.

Implementations

impl Error

pub fn new<S: AsRef<str>>(
    code: ErrorCode,
    class: ErrorClass,
    message: S
) -> Self

Creates a new error.

This is mainly intended for implementors of custom transports or database backends, where it is desirable to propagate an Error through libgit2.

pub fn last_error(code: c_int) -> Option<Error>

Returns the last error that happened with the code specified by code.

The code argument typically comes from the return value of a function call. This code will later be returned from the code function.

Historically this function returned Some or None based on the return value of git_error_last but nowadays it always returns Some so it's safe to unwrap the return value. This API will change in the next major version.

pub fn from_str(s: &str) -> Error

Creates a new error from the given string as the error.

The error returned will have the code GIT_ERROR and the class GIT_ERROR_NONE.

pub fn code(&self) -> ErrorCode

Return the error code associated with this error.

An error code is intended to be programmatically actionable most of the time. For example the code GIT_EAGAIN indicates that an error could be fixed by trying again, while the code GIT_ERROR is more bland and doesn't convey anything in particular.

pub fn set_code(&mut self, code: ErrorCode)

Modify the error code associated with this error.

This is mainly intended to be used by implementors of custom transports or database backends, and should be used with care.

pub fn class(&self) -> ErrorClass

Return the error class associated with this error.

Error classes are in general mostly just informative. For example the class will show up in the error message but otherwise an error class is typically not directly actionable.

pub fn set_class(&mut self, class: ErrorClass)

Modify the error class associated with this error.

This is mainly intended to be used by implementors of custom transports or database backends, and should be used with care.

pub fn raw_code(&self) -> git_error_code

Return the raw error code associated with this error.

pub fn raw_class(&self) -> git_error_t

Return the raw error class associated with this error.

pub fn message(&self) -> &str

Return the message associated with this error

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<JoinPathsError> for Error

pub fn from(e: JoinPathsError) -> Error

Performs the conversion.

impl From<NulError> for Error

pub fn from(_: NulError) -> Error

Performs the conversion.

impl PartialEq<Error> for Error

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Error