Struct Error

Source

pub struct Error { /* private fields */ }

Expand description

A structure to represent errors coming out of libgit2.

Implementations§

Source §

impl Error

Source

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

Creates a new error.

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

Source

pub fn last_error(code: i32) -> 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.

Source

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.

Source

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.

Source

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

Modify the error code associated with this error.

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

Source

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.

Source

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

Modify the error class associated with this error.

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

Source

pub fn raw_code(&self) -> i32

Return the raw error code associated with this error.

Source

pub fn raw_class(&self) -> u32

Return the raw error class associated with this error.

Source

pub fn message(&self) -> &str

Return the message associated with this error

Trait Implementations§

Source §

impl Debug for Error

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for Error

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Error for Error

1.30.0 · 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()

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 §