Struct GitwayError 

pub struct GitwayError { /* private fields */ }

The single error type returned by all gitway-lib operations.

Provides is_* predicate methods so callers can branch on error categories without depending on internal representation. A Backtrace is captured automatically; it is rendered via std::fmt::Display when RUST_BACKTRACE=1 is set.

Predicates

Method	Condition
is_io	Underlying I/O failure
is_host_key_mismatch	Server key does not match pinned fingerprints
is_authentication_failed	Server rejected our key
is_no_key_found	No identity key available
is_key_encrypted	Key file needs a passphrase

Implementations

impl GitwayError

pub fn host_key_mismatch(fingerprint: impl Into<String>) -> Self

pub fn authentication_failed() -> Self

pub fn no_key_found() -> Self

pub fn invalid_config(message: impl Into<String>) -> Self

pub fn is_io(&self) -> bool

Returns true if this error originated from an I/O failure.

pub fn is_host_key_mismatch(&self) -> bool

Returns true if the server’s host key did not match any pinned fingerprint.

pub fn is_authentication_failed(&self) -> bool

Returns true if the server rejected our public-key authentication attempt.

pub fn is_no_key_found(&self) -> bool

Returns true if no usable identity key was found.

pub fn is_key_encrypted(&self) -> bool

Returns true if a key file was found but requires a passphrase to decrypt.

pub fn fingerprint(&self) -> Option<&str>

Returns the path at which an encrypted key was found, if applicable.

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

Returns an upper-snake-case error code for structured JSON output (SFRS Rule 5).

Code	Exit code	Condition
GENERAL_ERROR	1	I/O, SSH protocol, or key-parsing failure
USAGE_ERROR	2	Invalid configuration or bad arguments
NOT_FOUND	3	No identity key found
PERMISSION_DENIED	4	Host key mismatch or authentication failure

pub fn exit_code(&self) -> u32

Returns the numeric process exit code for this error (SFRS Rule 2).

Code	Meaning
1	General / unexpected error
2	Usage error (bad arguments, invalid configuration)
3	Not found (no identity key, unknown host)
4	Permission denied (authentication failure, host key mismatch)

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

Returns a short diagnostic hint for structured JSON output (SFRS Rule 5).

Trait Implementations

impl Debug for GitwayError

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

Formats the value using the given formatter.

impl Display for GitwayError

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

Formats the value using the given formatter.

impl Error for GitwayError

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<AgentAuthError> for GitwayError

fn from(e: AgentAuthError) -> Self

Converts to this type from the input type.

impl From<Error> for GitwayError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for GitwayError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for GitwayError

fn from(e: Error) -> Self

Converts to this type from the input type.