Expand description

This crate allows to automatically implement From and reverse TryFrom on suitable enumerations.

In cases where you have an enumeration that wraps multiple different types, and you desire a From or reverse TryFrom implementation for each of them (for example, this is rather common with error handling, when you want to wrap errors from different libraries), this can be quite tedious to do manually.

Using the From and TryInto derive macros from the present crate, this work can be automated.

Example

Define an Error type that can be converted from both std::fmt::Error and std::io::Error (for facilitating use of the question mark operator), and that in addition offers a variant with a custom message that should not be available for automatic conversion:

#[derive(convert_enum::From)]
enum Error {
    #[convert_enum(optout)]
    Custom(Cow<'static, str>),
    Fmt(std::fmt::Error),
    Io(std::io::Error),
}

This results in the following implementations being generated automatically:

impl From<std::fmt::Error> for Error {
    fn from(val: std::fmt::Error) -> Self {
        Self::Fmt(val)
    }
}

impl From<std::io::Error> for Error {
    fn from(val: std::io::Error) -> Self {
        Self::Io(val)
    }
}

Derive Macros

Automatically generate From implementations for enum variants, ignoring ones marked #[convert_enum(optout)].

Automatically generate reverse TryFrom implementations for enum variants, ignore ones marked #[convert_enum(optout)].