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

Improve internal API docs for two file hashing functions

Browse source 
Co-Authored-By: Matthew Bauer <mjbauer95@gmail.com>
Co-Authored-By: Carlo Nucera <carlo.nucera@protonmail.com>
This commit is contained in:
John Ericson 2023-09-07 22:52:57 -04:00
parent f89b84919c
commit 39ba81a4eb
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/libutil/hash.hh
View file

@ -145,13 +145,17 @@ std::string printHash16or32(const Hash & hash);
Hash hashString(HashType ht, std::string_view s); Hash hashString(HashType ht, std::string_view s);
/** /**
* Compute the hash of the given file. * Compute the hash of the given file, hashing its contents directly.
*
* (Metadata, such as the executable permission bit, is ignored.)
*/ */
Hash hashFile(HashType ht, const Path & path); Hash hashFile(HashType ht, const Path & path);
/** /**
* Compute the hash of the given path. The hash is defined as * Compute the hash of the given path, serializing as a Nix Archive and
* (essentially) hashString(ht, dumpPath(path)). * then hashing that.
*
* The hash is defined as (essentially) hashString(ht, dumpPath(path)).
*/ */
typedef std::pair<Hash, uint64_t> HashResult; typedef std::pair<Hash, uint64_t> HashResult;
HashResult hashPath(HashType ht, const Path & path, HashResult hashPath(HashType ht, const Path & path,