Algorithm newtype introduced in createHash for better type safety#16
Open
m-rinaldi wants to merge 1 commit into
Open
Algorithm newtype introduced in createHash for better type safety#16m-rinaldi wants to merge 1 commit into
m-rinaldi wants to merge 1 commit into
Conversation
This file contains hidden or 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
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.
Changed the type of
createHashfromString -> Effect HashtoAlgorithm -> Effect Hash.So far,
createHashhas accepted aStringrepresenting the hash algorithm. This is ambiguous and error-prone — it gives no clue that the string represents the algorithm name, not the input to be hashed. This can easily lead to misuse or confusion, for example:This example will compile, but crash at runtime with:
By introducing the
Algorithmnewtype:We make incorrect usage visibly suspicious. The newtype acts as a clue, encouraging the user to pause and consider what this string actually represents. It clarifies intent and helps prevent real-world runtime errors.