Feature/issue 21 #60
Open
Feature/issue 21 #60
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
drcapybara
reviewed
Apr 5, 2024
Comment on lines
+127
to
+138
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use capycrypt::SecParam; | ||
| /// use capycrypt::OperationError; | ||
| /// | ||
| /// assert_eq!(SecParam::from_int(224).unwrap(), SecParam::D224); | ||
| /// assert_eq!(SecParam::from_int(256).unwrap(), SecParam::D256); | ||
| /// assert_eq!(SecParam::from_int(384).unwrap(), SecParam::D384); | ||
| /// assert_eq!(SecParam::from_int(512).unwrap(), SecParam::D512); | ||
| /// assert_eq!(SecParam::from_int(1024), Err(OperationError::UnsupportedSecurityParameter)) | ||
| /// ``` |
There was a problem hiding this comment.
these doc tests can be really hard to maintain if we ever need to change the security parameters. I would recommend removing this section and simply stating the supported security params as simple comments instead
drcapybara
reviewed
Apr 5, 2024
| #[derive(Debug, StructOpt)] | ||
| #[structopt( | ||
| name = "capycrypt-cli", | ||
| about = "Support command-line interface for capyCrypt library" |
There was a problem hiding this comment.
Suggested change
| about = "Support command-line interface for capyCrypt library" | |
| about = "Command-line interface for capycrypt library" |
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 pull request implements a command-line interface (CLI) for the SHA-3 hash function.
To use this feature, users can follow these steps:
cargo install --path .After installation, users can execute the following command:
Replace "msg" with the message to be hashed and security_bit with the desired security level in bits."