Feature guarded no_std support #1
Draft
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
name: no_std about: Supporting no_std compilation mode --- **Description of feature:** Make the library compatible with no_std environments. **Implementation:** The std target implementation remains unchanged. The majority of changes are switching to using core and alloc where std used to be. The no_std flavor uses no_std compatible collections and synchronization primitives. The thiserror crate doesn't have no_std support hence the error types where reimplemented manually. Signed-off-by: Dzmitry Huba <[email protected]>
tiziano88
approved these changes
Jul 13, 2023
|
|
||
| /// The base error type for raft | ||
| #[derive(Debug, Error)] | ||
| #[derive(Debug)] |
There was a problem hiding this comment.
Why was Error removed? Is it not no_std compatible at all? I thought the issue was just with the IO errors.
Perhaps consider one of those instead
| pub enum Error { | ||
| /// An IO error occurred | ||
| #[error("{0}")] | ||
| Io(#[from] std::io::Error), | ||
| #[cfg(feature = "std")] |
There was a problem hiding this comment.
Add a comment explaining why this needs to be excluded in no_std.
andrisaar
reviewed
Jul 13, 2023
| @@ -1,61 +1,110 @@ | |||
| // Copyright 2019 TiKV Project Authors. Licensed under Apache-2.0. | |||
| use thiserror::Error; | |||
There was a problem hiding this comment.
After this change is thiserror used at all? Could you get rid of that dependency altogether?
(Or, if it is used somewhere else, why is that "somewhere else" not breaking no_std?)
Signed-off-by: Dzmitry Huba <[email protected]>
…uses stable version and no-std requires an experimental feature. Signed-off-by: Dzmitry Huba <[email protected]>
Signed-off-by: Dzmitry Huba <[email protected]>
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.
name: no_std
about: Supporting no_std compilation mode
Description of feature:
Make the library compatible with no_std environments.
Implementation:
The std target implementation remains unchanged. The majority of changes are switching to using core and alloc where std used to be. The no_std flavor uses no_std compatible collections and synchronization primitives. The thiserror crate doesn't have no_std support hence the error types where reimplemented manually.