Struct Error

pub struct Error {
    pub source_location: SourceLocation,
    pub kind: ErrorKind,
    pub message: Option<String>,
}

The main Error class to be used in each Result(Whatever,Error). It contains the code source of the error and its kind. An arbitrary String message can be optionally attached.

Fields

source_location: SourceLocation

kind: ErrorKind

message: Option<String>

Implementations

impl Error

pub fn new(source_location: SourceLocation, kind: ErrorKind) -> Error

pub fn with_message(self, message: String) -> Error

pub fn command_not_found( source_location: SourceLocation, path: String, io_error: Error, ) -> Error

example call: Error::new_command_not_found(source_location!(),“squeue”.to_string(),e).

pub fn nonsense_command_output(source_location: SourceLocation) -> Error

pub fn missing_environment_variable( source_location: SourceLocation, variable: String, var_error: VarError, ) -> Error

pub fn could_not_start_sftp_session( source_location: SourceLocation, error: Error, ) -> Error

pub fn could_not_open_file( source_location: SourceLocation, filepath: PathBuf, error: Error, ) -> Error

pub fn could_not_open_remote_file( source_location: SourceLocation, filepath: PathBuf, error: Error, ) -> Error

pub fn could_not_parse_file( source_location: SourceLocation, filepath: PathBuf, ) -> Error

pub fn ill_formed_configuration( source_location: SourceLocation, value: ConfigurationValue, ) -> Error

pub fn authentication_failed( source_location: SourceLocation, error: Error, ) -> Error

pub fn could_not_generate_file( source_location: SourceLocation, filepath: PathBuf, error: Error, ) -> Error

pub fn file_system_error(source_location: SourceLocation, error: Error) -> Error

pub fn remote_file_system_error( source_location: SourceLocation, error: Error, ) -> Error

pub fn incompatible_configurations(source_location: SourceLocation) -> Error

pub fn bad_argument(source_location: SourceLocation) -> Error

pub fn undetermined(source_location: SourceLocation) -> 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, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.