Clarify when FromStrErr is used.

This commit is contained in:
Jimmy Cuadra 2019-07-23 00:26:35 -07:00
parent 2d2e29f349
commit 4c7156b187

View File

@ -231,6 +231,9 @@ impl Display for InvalidInput {
impl Error for InvalidInput {}
/// An error when attempting to create a value from a string via the `FromStr` trait.
///
/// This error type is only used for simple enums with unit variants. Event deserialization through
/// the `FromStr` trait returns an `InvalidEvent` on error.
#[derive(Clone, Copy, Eq, Debug, Hash, PartialEq)]
pub struct FromStrError;