Introduce a separate Hash struct. #28
Merged
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
This is intended to make the API clearer in separating the hash, which is part of the `GitOid` but not sufficient for representing the `GitOid`, from the overall `GitOid` structure. The `GitOid` can be represented as a URI, or you can extract the parts (hash algorithm, object type, hash) individually. If you have the `Hash`, now represented as a struct, you can either access the individual bytes through the `Deref` impl or `as_bytes` method, or you can get the hexadecimal encoding through the `Display` impl or the implied `to_string` method or explicit `hex` method. Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>
Member
Author
|
One thing I am definitely open for feedback on is the name of the new struct. The standard library has |
alilleybrinker
added
type: feature
This commit derives some common traits for the `Hash` struct, to make it more usable/complete in terms of providing the normally-expected APIs. Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>
Collaborator
|
I agree with the need to differentiate the new struct from |
Collaborator
|
Other than my comment ^, this looks good! |
This commit renames the `Hash` struct to `HashRef` to avoid any conflicts with the `std::hash::Hash` trait. Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>
Member
Author
|
Great! I've done the rename and changed the import of |
nellshamrell
approved these changes
Sep 22, 2022
Collaborator
nellshamrell
left a comment
nellshamrell
left a comment
There was a problem hiding this comment.
Looks great! Merging!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 is intended to make the API clearer in separating the hash, which is part of the
GitOidbut not sufficient for representing theGitOid, from the overallGitOidstructure. TheGitOidcan be represented as a URI, or you can extract the parts (hash algorithm, object type, hash) individually. If you have theHash, now represented as a struct, you can either access the individual bytes through theDerefimpl oras_bytesmethod, or you can get the hexadecimal encoding through theDisplayimpl or the impliedto_stringmethod or explicithexmethod.Signed-off-by: Andrew Lilley Brinker alilleybrinker@gmail.com