Enum wix::Error

pub enum Error {
    Command(&'static str, i32, bool),
    Generic(String),
    Io(Error),
    Manifest(&'static str),
    Mustache(Error),
    Toml(Error),
    Version(SemVerError),
}

The error type for wix-related operations and associated traits.

Errors mostly originate from the dependencies, but custom instances of Error can be created with the Generic variant and a message.

Variants

Command(&'static str, i32, bool)

A command operation failed.

Generic(String)

A generic or custom error occurred. The message should contain the detailed information.

Io(Error)

An I/O operation failed.

Manifest(&'static str)

A needed field within the Cargo.toml manifest could not be found.

Mustache(Error)

An error occurred with rendering the template using the mustache renderer.

Toml(Error)

Parsing of the Cargo.toml manifest failed.

Version(SemVerError)

Parsing error for a version string or field.

Implementations

impl Error

pub fn code(&self) -> i32

Gets an error code related to the error.

Examples

extern crate wix;

use wix::Error;

fn main() {
    let err = Error::from("A generic error");
    assert_ne!(err.code(), 0)
}

This is useful as a return, or exit, code for a command line application, where a non-zero integer indicates a failure in the application. it can also be used for quickly and easily testing equality between two errors.

pub fn already_exists(p: &Path) -> Self

Creates a new Error from a std::io::Error with the std::io::ErrorKind::AlreadyExists variant.

Examples

extern crate wix;

use std::io;
use std::path::Path;
use wix::Error;

fn main() {
    let path = Path::new("C:\\");
    let expected = Error::Io(io::Error::new(
        io::ErrorKind::AlreadyExists,
        path.display().to_string()
    ));
    assert_eq!(expected, Error::already_exists(path));
}

pub fn not_found(p: &Path) -> Self

Creates a new Error from a std::io::Error with the std::io::ErrorKind::NotFound variant.

Examples

extern crate wix;

use std::io;
use std::path::Path;
use wix::Error;

fn main() {
    let path = Path::new("C:\\Cargo\\Wix\\file.txt");
    let expected = Error::Io(io::Error::new(
        io::ErrorKind::NotFound,
        path.display().to_string()
    ));
    assert_eq!(expected, Error::not_found(path));
}

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()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

The lower-level source 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<'a> From<&'a str> for Error

fn from(s: &str) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.

impl From<SemVerError> for Error

fn from(err: SemVerError) -> Self

Performs the conversion.

impl From<StripPrefixError> for Error

fn from(err: StripPrefixError) -> Self

Performs the conversion.

impl PartialEq<Error> for Error

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.