mirror of
https://github.com/NixOS/nix.git
synced 2025-12-10 02:51:02 +01:00
fd47f76da9
"hash type" -> "hash algorithm" in all comments, documentation, and messages. ht -> ha, [Hh]ashType -> [HhashAlgo] for all local variables and function arguments. No API change is made. Continuation of5334c9c792and837b889c41.
73 lines
1.7 KiB
C++
73 lines
1.7 KiB
C++
#pragma once
|
|
///@file
|
|
|
|
#include "source-accessor.hh"
|
|
#include "fs-sink.hh"
|
|
#include "util.hh"
|
|
|
|
namespace nix {
|
|
|
|
/**
|
|
* An enumeration of the main ways we can serialize file system
|
|
* objects.
|
|
*/
|
|
enum struct FileIngestionMethod : uint8_t {
|
|
/**
|
|
* Flat-file hashing. Directly ingest the contents of a single file
|
|
*/
|
|
Flat = 0,
|
|
/**
|
|
* Recursive (or NAR) hashing. Serializes the file-system object in
|
|
* Nix Archive format and ingest that.
|
|
*/
|
|
Recursive = 1,
|
|
};
|
|
|
|
/**
|
|
* Parse a `FileIngestionMethod` by name. Choice of:
|
|
*
|
|
* - `flat`: `FileIngestionMethod::Flat`
|
|
* - `nar`: `FileIngestionMethod::Recursive`
|
|
*
|
|
* Oppostite of `renderFileIngestionMethod`.
|
|
*/
|
|
FileIngestionMethod parseFileIngestionMethod(std::string_view input);
|
|
|
|
/**
|
|
* Render a `FileIngestionMethod` by name.
|
|
*
|
|
* Oppostite of `parseFileIngestionMethod`.
|
|
*/
|
|
std::string_view renderFileIngestionMethod(FileIngestionMethod method);
|
|
|
|
/**
|
|
* Dump a serialization of the given file system object.
|
|
*/
|
|
void dumpPath(
|
|
SourceAccessor & accessor, const CanonPath & path,
|
|
Sink & sink,
|
|
FileIngestionMethod method,
|
|
PathFilter & filter = defaultPathFilter);
|
|
|
|
/**
|
|
* Restore a serialization of the given file system object.
|
|
*
|
|
* @TODO use an arbitrary `FileSystemObjectSink`.
|
|
*/
|
|
void restorePath(
|
|
const Path & path,
|
|
Source & source,
|
|
FileIngestionMethod method);
|
|
|
|
/**
|
|
* Compute the hash of the given file system object according to the
|
|
* given method.
|
|
*
|
|
* The hash is defined as (essentially) hashString(ha, dumpPath(path)).
|
|
*/
|
|
HashResult hashPath(
|
|
SourceAccessor & accessor, const CanonPath & path,
|
|
FileIngestionMethod method, HashAlgorithm ha,
|
|
PathFilter & filter = defaultPathFilter);
|
|
|
|
}
|