Struct user_error::UserFacingError

pub struct UserFacingError<S: UFEState> { /* fields omitted */ }

The eponymous struct.

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .reason("File not found")
                            .helptext("Make sure foo.txt exists");

Methods

impl UserFacingError<Start>

pub fn new(s: &str) -> UserFacingError<Start>

This is how users create a new User Facing Error. The value passed to new() will be used as an error summary. Error summaries are displayed first, prefixed by 'Error: '.

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open");

pub fn print(&self)

Prints the error

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open");
err.print();

pub fn print_and_exit(&self) -> !

Prints the error and then exits the program

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open");
err.print_and_exit();

pub fn reason(self, r: &str) -> UserFacingError<Reason>

Add a reason to the UserFacingError. Reasons are displayed in a bulleted list below the summary.

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .reason("File not found")
                            .reason("Directory cannot be entered");

pub fn helptext(self, h: &str) -> UserFacingError<HelpText>

Add help text to the error. Help text is displayed last, in a muted fashion. Once you add help text you cannot add additional reasons.

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .reason("File not found")
                            .helptext("Check if the file exists.");

This will not compile

let err = UserFacingError::new("File failed to open")
                            .helptext("Check if the file exists.")
                            .reason("File not found");

impl UserFacingError<HelpText>

pub fn print(&self)

Prints the error

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .helptext("Check that it exists");
err.print();

pub fn print_and_exit(&self) -> !

Prints the error and then exits the program

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .helptext("Check that it exists");
err.print_and_exit();

impl UserFacingError<Reason>

pub fn from(error: &dyn Error) -> Self

Allows the creation of a UserFacingError from a Error. Checks the source() of the error and will list underlying errors as reasons for the error. You may add additional reasons and helptext.

Example

use user_error::UserFacingError;

let ioe = std::io::Error::new(std::io::ErrorKind::Other, "Error");
let ufe = UserFacingError::from(&ioe);    let ioe = std::io::Error::new(std::io::ErrorKind::Other, "Error");          
let ufe = ufe.reason("No good reason");

pub fn print(&self)

Prints the error

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .reason("File not found");
err.print();

pub fn print_and_exit(&self) -> !

Prints the error and then exits the program

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .reason("File not found");
err.print_and_exit();

pub fn reason(self, r: &str) -> Self

Add a reason to the UserFacingError. Reasons are displayed in a bulleted list below the summary.

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .reason("File not found")
                            .reason("Directory cannot be entered");

pub fn helptext(self, h: &str) -> UserFacingError<ReasonsAndHelp>

Add help text to the error. Help text is displayed last, in a muted fashion. Once you add help text you cannot add additional reasons.

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .reason("File not found")
                            .helptext("Check if the file exists.");

This will not compile

let err = UserFacingError::new("File failed to open")
                            .helptext("Check if the file exists.")
                            .reason("File not found");

impl UserFacingError<ReasonsAndHelp>

pub fn print(&self)

Prints the error

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .reason("File not found")
                            .helptext("Make sure the file exists");
err.print();

pub fn print_and_exit(&self) -> !

Prints the error and then exits the program

Example

use user_error::UserFacingError;

let err = UserFacingError::new("File failed to open")
                            .reason("File not found")
                            .helptext("Make sure the file exists");
err.print_and_exit();

Trait Implementations

impl<S: Debug + UFEState> Debug for UserFacingError<S>

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

Formats the value using the given formatter.

impl Display for UserFacingError<Start>

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

Formats the value using the given formatter.

impl Display for UserFacingError<HelpText>

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

Formats the value using the given formatter.

impl Display for UserFacingError<Reason>

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

Formats the value using the given formatter.

impl Display for UserFacingError<ReasonsAndHelp>

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

Formats the value using the given formatter.

impl Error for UserFacingError<Start>

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

The lower-level source of this error, if any.

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

impl Error for UserFacingError<HelpText>

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

The lower-level source of this error, if any.

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

impl Error for UserFacingError<Reason>

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

The lower-level source of this error, if any.

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

impl Error for UserFacingError<ReasonsAndHelp>

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

The lower-level source of this error, if any.

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.