Advice for library writers
Idioms for Rust libraries are still forming, but if your library needs to report custom errors, then you should probably define your own error type. It’s up to you whether or not to expose its representation (like ErrorKind
) or keep it hidden (like ParseIntError
). Regardless of how you do it, it’s usually good practice to at least provide some information about the error beyond just its String
representation. But certainly, this will vary depending on use cases.
At a minimum, you should probably implement the Error
trait. This will give users of your library some minimum flexibility for composing errors. Implementing the Error
trait also means that users are guaranteed the ability to obtain a string representation of an error (because it requires impls for both fmt::Debug
and fmt::Display
).
Beyond that, it can also be useful to provide implementations of From
on your error types. This allows you (the library author) and your users to compose more detailed errors. For example, csv::Error
provides From
impls for both io::Error
and byteorder::Error
.
Finally, depending on your tastes, you may also want to define a Result
type alias, particularly if your library defines a single error type. This is used in the standard library for io::Result
and fmt::Result
.
From: Error Handling in Rust - Andrew Gallant's Blog (burntsushi.net)