Struct Error

pub struct Error { /* private fields */ }

Representation of an error that can occur within libssh2

Implementations

impl Error

pub fn from_session_error(sess: &Session, rc: c_int) -> Error

Given a libssh2 error return code, generate an Error object that encapsulates that error code and the error reason. The error reason is extracted from the Session and is used if the session contains the same error code as that provided. If the error code doesn’t match then an approximation of the error reason is used instead of the error message stored in the Session.

pub fn last_session_error(sess: &Session) -> Option<Error>

Generate the last error that occurred for a Session.

Returns None if there was no last error.

pub fn new(code: ErrorCode, msg: &'static str) -> Error

Create a new error for the given code and message

pub fn eof() -> Error

Generate an error that represents EOF

pub fn unknown() -> Error

Generate an error for unknown failure

pub fn from_errno(code: ErrorCode) -> Error

Construct an error from an error code from libssh2

pub fn message(&self) -> &str

Get the message corresponding to this error

pub fn code(&self) -> ErrorCode

Return the code for this error

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

Returns the lower-level source of this error, if any.

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(err: Error) -> Error

Converts to this type from the input type.

impl From<NulError> for Error

fn from(_: NulError) -> Error

Converts to this type from the input type.