puck/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

Document HashFormat

Browse source
This commit is contained in:
Yueh-Shun Li 2023-10-18 17:08:06 +08:00
parent 838c70f621
commit 5043e6cf4e
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/libutil/hash.hh
View file

@ -23,7 +23,21 @@ extern std::set<std::string> hashTypes;
extern const std::string base32Chars;
enum HashFormat : int { Base64, Base32, Base16, SRI };
/**
* @brief Enumeration representing the hash formats.
*/
enum HashFormat : int {
/// @brief Base 64 encoding.
/// @see [IETF RFC 4648, section 4](https://datatracker.ietf.org/doc/html/rfc4648#section-4).
Base64,
/// @brief Nix-specific base-32 encoding. @see base32Chars
Base32,
/// @brief Lowercase hexadecimal encoding. @see base16Chars
Base16,
/// @brief "<hash algo>:<Base 64 hash>", format of the SRI integrity attribute.
/// @see W3C recommendation [Subresource Intergrity](https://www.w3.org/TR/SRI/).
SRI
};
struct Hash