Refactor error types #67
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
sosthene-nitrokey
requested changes
Jul 4, 2024
src/fs.rs
Outdated
| @@ -1254,23 +1254,19 @@ impl<'a, Storage: driver::Storage> Filesystem<'a, Storage> { | |||
| let path_slice = path.as_ref().as_bytes(); | |||
| for i in 0..path_slice.len() { | |||
| if path_slice[i] == b'/' { | |||
| let dir = PathBuf::try_from(&path_slice[..i])?; | |||
| let dir = PathBuf::try_from(&path_slice[..i]).map_err(|_| ErrorKind::Io)?; | |||
There was a problem hiding this comment.
Maybe this should be ErrorKind::NameTooLong?
There was a problem hiding this comment.
I did not want to change the existing behavior, but I think this cannot fail anyway. If we would have a proper split method in Path, we could get rid of the error entirely.
|
If the constants on |
sosthene-nitrokey
approved these changes
Jul 4, 2024
|
That's a good point. We can re-introduce ErrorKind in the future if we ever need it. |
|
Okay. Then I would change the constant names to match the old variant names, e. g. |
To make it easier to add support for new error codes without breaking compatibility, this patch replaces the Error enum with a struct and associated constants. As a part of this change, it also enforces that Error is not used for return values indicating success, i. e. only for negative return values.
daringer
approved these changes
Jul 16, 2024
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.
This PR splits the
Errorenum into anErrorstruct and a non-exhaustiveErrorKindenum. This makes it possible to add support for new error codes without breaking compatibility. The PR also removes the edge case ofErrorinstances for non-negative return values indicating success.See this issue for context and discussion:
Contrary to the suggestion in #55 (comment), this implementation does not provide a
fn error(&self) -> Option<ErrorKind>onError. It would again cause the problem that users could rely on this method returningNonefor some currently unsupported error. Instead,ErrorimplementsPartialEq<ErrorKind>so that users can compare it directly against known error kinds. The only limitation is that it is not possible tomatchon the error kind, but I don’t see a need for that anyway.