mirror of
https://github.com/NixOS/nix.git
synced 2025-12-15 13:31:05 +01:00
0e35cd6f3e
* It is tough to contribute to a project that doesn't use a formatter, * It is extra hard to contribute to a project which has configured the formatter, but ignores it for some files * Code formatting makes it harder to hide obscure / weird bugs by accident or on purpose, Let's rip the bandaid off? Note that PRs currently in flight should be able to be merged relatively easily by applying `clang-format` to their tip prior to merge. Co-authored-by: Graham Christensen <graham@grahamc.com>
148 lines
4 KiB
C++
148 lines
4 KiB
C++
#pragma once
|
|
///@file
|
|
|
|
#include "nix/util/source-accessor.hh"
|
|
|
|
namespace nix {
|
|
|
|
struct SourcePath;
|
|
|
|
/**
|
|
* An enumeration of the ways we can serialize file system
|
|
* objects.
|
|
*
|
|
* See `file-system-object/content-address.md#serial` in the manual for
|
|
* a user-facing description of this concept, but note that this type is also
|
|
* used for storing or sending copies; not just for addressing.
|
|
* Note also that there are other content addressing methods that don't
|
|
* correspond to a serialisation method.
|
|
*/
|
|
enum struct FileSerialisationMethod : uint8_t {
|
|
/**
|
|
* Flat-file. The contents of a single file exactly.
|
|
*
|
|
* See `file-system-object/content-address.md#serial-flat` in the
|
|
* manual.
|
|
*/
|
|
Flat,
|
|
|
|
/**
|
|
* Nix Archive. Serializes the file-system object in
|
|
* Nix Archive format.
|
|
*
|
|
* See `file-system-object/content-address.md#serial-nix-archive` in
|
|
* the manual.
|
|
*/
|
|
NixArchive,
|
|
};
|
|
|
|
/**
|
|
* Parse a `FileSerialisationMethod` by name. Choice of:
|
|
*
|
|
* - `flat`: `FileSerialisationMethod::Flat`
|
|
* - `nar`: `FileSerialisationMethod::NixArchive`
|
|
*
|
|
* Opposite of `renderFileSerialisationMethod`.
|
|
*/
|
|
FileSerialisationMethod parseFileSerialisationMethod(std::string_view input);
|
|
|
|
/**
|
|
* Render a `FileSerialisationMethod` by name.
|
|
*
|
|
* Opposite of `parseFileSerialisationMethod`.
|
|
*/
|
|
std::string_view renderFileSerialisationMethod(FileSerialisationMethod method);
|
|
|
|
/**
|
|
* Dump a serialization of the given file system object.
|
|
*/
|
|
void dumpPath(
|
|
const SourcePath & path, Sink & sink, FileSerialisationMethod method, PathFilter & filter = defaultPathFilter);
|
|
|
|
/**
|
|
* Restore a serialisation of the given file system object.
|
|
*
|
|
* \todo use an arbitrary `FileSystemObjectSink`.
|
|
*/
|
|
void restorePath(const Path & path, Source & source, FileSerialisationMethod method, bool startFsync = false);
|
|
|
|
/**
|
|
* Compute the hash of the given file system object according to the
|
|
* given method.
|
|
*
|
|
* the hash is defined as (in pseudocode):
|
|
*
|
|
* ```
|
|
* hashString(ha, dumpPath(...))
|
|
* ```
|
|
*/
|
|
HashResult hashPath(
|
|
const SourcePath & path, FileSerialisationMethod method, HashAlgorithm ha, PathFilter & filter = defaultPathFilter);
|
|
|
|
/**
|
|
* An enumeration of the ways we can ingest file system
|
|
* objects, producing a hash or digest.
|
|
*
|
|
* See `file-system-object/content-address.md` in the manual for a
|
|
* user-facing description of this concept.
|
|
*/
|
|
enum struct FileIngestionMethod : uint8_t {
|
|
/**
|
|
* Hash `FileSerialisationMethod::Flat` serialisation.
|
|
*
|
|
* See `file-system-object/content-address.md#serial-flat` in the
|
|
* manual.
|
|
*/
|
|
Flat,
|
|
|
|
/**
|
|
* Hash `FileSerialisationMethod::NixArchive` serialisation.
|
|
*
|
|
* See `file-system-object/content-address.md#serial-flat` in the
|
|
* manual.
|
|
*/
|
|
NixArchive,
|
|
|
|
/**
|
|
* Git hashing.
|
|
*
|
|
* Part of `ExperimentalFeature::GitHashing`.
|
|
*
|
|
* See `file-system-object/content-address.md#serial-git` in the
|
|
* manual.
|
|
*/
|
|
Git,
|
|
};
|
|
|
|
/**
|
|
* Parse a `FileIngestionMethod` by name. Choice of:
|
|
*
|
|
* - `flat`: `FileIngestionMethod::Flat`
|
|
* - `nar`: `FileIngestionMethod::NixArchive`
|
|
* - `git`: `FileIngestionMethod::Git`
|
|
*
|
|
* Opposite of `renderFileIngestionMethod`.
|
|
*/
|
|
FileIngestionMethod parseFileIngestionMethod(std::string_view input);
|
|
|
|
/**
|
|
* Render a `FileIngestionMethod` by name.
|
|
*
|
|
* Opposite of `parseFileIngestionMethod`.
|
|
*/
|
|
std::string_view renderFileIngestionMethod(FileIngestionMethod method);
|
|
|
|
/**
|
|
* Compute the hash of the given file system object according to the
|
|
* given method, and for some ingestion methods, the size of the
|
|
* serialisation.
|
|
*
|
|
* Unlike the other `hashPath`, this works on an arbitrary
|
|
* `FileIngestionMethod` instead of `FileSerialisationMethod`, but
|
|
* may not return the size as this is this is not a both simple and
|
|
* useful defined for a merkle format.
|
|
*/
|
|
std::pair<Hash, std::optional<uint64_t>> hashPath(
|
|
const SourcePath & path, FileIngestionMethod method, HashAlgorithm ha, PathFilter & filter = defaultPathFilter);
|
|
|
|
} // namespace nix
|