Skip to content

error types should have a Error suffix #13627

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

Open
ShahakShama wants to merge 1 commit into
base: shahak/style-guide-expect-vs-allow
Choose a base branch
from
Open

error types should have a Error suffix #13627

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
5 changes: 5 additions & 0 deletions style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,15 @@ async fn test_delayed_operation() {

## Error Handling & Safety


Use `Result<T, E>` for recoverable errors and `panic!` only for bugs.

Use `todo!` for to-be-completed code sections.

Don't use `unreachable!` and `unimplemented!`, as they are very similar in meaning to `panic!` and `todo!` and it's not worth the headache of figuring which one fits better.

Error structs and enums should have names ending with `Error` (e.g. `StorageError`, `ParseTransactionError`).

### expect message

Write `expect` messages for code readers, not for the program runner. Explain _why_ the error should never happen, not _what_ is the error. State the invariant rather than saying that it broke.
Expand Down
Loading