Skip to content

Fix documentation example for transparent error pattern #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
veeceey wants to merge 1 commit into from
+18 −4
Closed

Fix documentation example for transparent error pattern #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,9 @@ pub enum DataStoreError {
// Private and free to change across minor version of the crate.
#[derive(Error, Debug)]
enum ErrorRepr {
...
#[error("invalid input")]
InvalidInput(#[from] InvalidInputError),
// Additional error variants can be added here
}
```

Expand Down
18 changes: 15 additions & 3 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,10 +245,22 @@
//! // Private and free to change across minor version of the crate.
//! #[derive(Error, Debug)]
//! enum ErrorRepr {
//! # /*
//! ...
//! # */
//! #[error("invalid input")]
//! InvalidInput(#[from] InvalidInputError),
//! }
//! #
//! # #[derive(Error, Debug)]
//! # #[error("invalid input")]
//! # struct InvalidInputError;
//! #
//! # fn process() -> Result<(), ErrorRepr> {
//! # Err(InvalidInputError.into())
//! # }
//! #
//! # fn example() -> Result<(), PublicError> {
//! # process()?;
//! # Ok(())
//! # }
//! ```
//!
//! - See also the [`anyhow`] library for a convenient single error type to use
Expand Down