feat: thiserror, tracingクレートの導入 #8
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AsPulse
requested changes
Oct 22, 2024
clocking-server/src/err.rs
Outdated
Comment on lines
9
to
28
| #[error("initialize tracing subscriber error. {0}")] | ||
| InitializeTracingSubscriber(TryInitError), | ||
| #[error("create tcp listener error. err: {0}, port: {1}")] | ||
| CreateTCPListener(io::Error, u16), | ||
| #[error("accept new connection")] | ||
| AcceptNewConnection(io::Error), | ||
| #[error("accept new stream")] | ||
| AcceptNewStream(io::Error), | ||
| #[error("private key pem section not found")] | ||
| ReadPrivateKeyPEMSection, | ||
| #[error("unexpected rust ls error. {0}")] | ||
| BuildServer(rustls::Error), | ||
| #[error("failed to open file. {0}")] | ||
| OpenFile(io::Error), | ||
| #[error("failed to read file. {0}")] | ||
| ReadFile(io::Error), | ||
| #[error("failed to read buffer. {0}")] | ||
| ReadBuffer(io::Error), | ||
| #[error("failed to convert string. {0}")] | ||
| ConvertBuffer(FromUtf8Error), |
There was a problem hiding this comment.
ぜ、全体的にエラー文が雑……！
「ReadFile」や「OpenFile」とかのエラーはよくないです
代わりに、LoadPrivateKeyFileみたいな……意識する場所としては、「それを受けとったユーザーが何をすればいいのか」が分かるように……！
逆にそのようにエラーがまとまってれば、Openで失敗したかReadで失敗したかは割とどうでもいいわけです。
(きっと {0} のように参照される部分で表示されるからね！例えばFailed to load Private Key File: file not found みたいな)
また、エラー文の末尾にピリオドとかはつけません
いろいろ参考になるかも？
https://doc.rust-jp.rs/rust-by-example-ja/error/multiple_error_types/define_error_type.html
|
あと、プルリクエスト名がメインブランチへのコミットメッセージになっちゃうのでConventionalに従ってください |
HMasataka
force-pushed
the
feature/error_trace
branch
from
89b8850 to
2e510f5
Compare
AsPulse
approved these changes
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Box<dyn Error>としていた箇所を全て共通のエラーとして処理出来るように発生したエラーをwrap