Struct Error

pub struct Error {
    pub name: String,
    pub description: String,
    pub exit_code: i32,
}

Error object.

Use Error::new() to create error objects instead of using this struct.

Parameters

• name: The errors name.
• description: The error description.
• exit_code: The errors exit code.

Returns

A new Error object with the specified name and description.

Examples

logging_rs::errors::Error {
    name: "name".to_owned(),
    description: "description".to_owned(),
    exit_code: 1
};

Fields

name: String

The errors name.

description: String

The error description.

exit_code: i32

The errors exit code.

Implementations

impl Error

pub fn new(name: &str, description: &str, exit_code: i32) -> Error

Creates a new error object.

Parameters

• name: The errors name.
• description: The error description.
• exit_code: The errors exit code.

Returns

A new Error object with the specified name and description.

Examples

logging_rs::errors::Error::new("name", "description", 1);

See also

• Error

pub fn raise(&self, details: &str)

Raises the error and exits with the specified exit code.

Parameters

• self: The error object.
• details: The error details.

Aborts

Exits with the specified exit code.

Examples

error.raise("Something went very wrong");

See also

• Error

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

Display implementation for the error object.

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

Format implementation for the error object.

Parameters

• self: The error object.
• f: The fmt::Formatter to use.

Returns

A fmt::Result containing the formatted error message.

Examples

println!("{}", error);

See also

• fmt::Display
• Error

impl Ord for Error

fn cmp(&self, other: &Error) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Error

fn partial_cmp(&self, other: &Error) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Error

impl StructuralPartialEq for Error