Enum Error 

pub enum Error {
    Protocol(String),
    Invalid(String),
    ObjectFormat {
        ours: &'static str,
        theirs: &'static str,
    },
    Remote(String),
    Io(Error),
}

What went wrong.

Variants

Protocol(String)

The peer put something on the wire this grammar cannot read.

Invalid(String)

The caller asked for something that cannot be put on the wire.

Separated from Error::Protocol because the two have different audiences: a protocol error is the remote’s fault and belongs in a diagnostic, an invalid request is the caller’s and belongs in a compile-time-adjacent complaint.

ObjectFormat

The peer used a hash algorithm this repository does not.

A variant of its own rather than a Error::Protocol string, because it is the one protocol error a caller routinely wants to re-report in its own vocabulary — an object-format mismatch is what a server tells a client in its status report, and digging two algorithm names back out of a formatted message to do so is how a message becomes an API by accident.

Fields

ours: &'static str

The repository’s algorithm, as it appears in object-format=.

theirs: &'static str

The peer’s.

Remote(String)

The remote refused the conversation and said why, in an ERR <msg> packet or on sideband 3.

Its own variant rather than an Error::Protocol string because it is not a protocol error: the grammar was obeyed exactly. ERR is the one line in the advertisement that is a sentence for a human rather than a record for a parser, and reading it as a ref turns you are not allowed to push here into bad object id "ERR" for ref "you are not allowed to push here".

The wording is git’s — connect.c answers an ERR packet with die(_("remote error: %s"), arg) — so an operator who has seen the message from git does not have to learn a second phrase for it. Measured against git 2.53.0: fatal: remote error: you are not allowed to push here, exit 128.

Io(Error)

The socket, the pipe or the file underneath.

Implementations

impl Error

pub fn protocol(message: impl Display) -> Self

A protocol error from anything printable.

pub fn invalid(message: impl Display) -> Self

An invalid-request error from anything printable.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(source: Error) -> Self

Converts to this type from the input type.