Skip to main content

Crate nix_narinfo

Crate nix_narinfo 

Source
Expand description

Pure Rust parsing, canonical writing, and validation for Nix binary-cache metadata: .narinfo records and derivation-output realisations (.doi).

This crate deliberately contains no transport, decompression, store mutation, or trust-policy code. Callers fetch the record, choose supported compression, and decide whether a valid signature is required.

§Example

use nix_derivation::StoreDir;
use nix_narinfo::{Compression, NarInfo};

let record = b"StorePath: /nix/store/00000000000000000000000000000000-example\n\
URL: nar/example.nar\n\
NarHash: sha256:0000000000000000000000000000000000000000000000000000\n\
NarSize: 1\n";
let store_dir = StoreDir::default();
let info = NarInfo::parse_in(&store_dir, record)?;

assert_eq!(info.compression(), &Compression::Bzip2);
assert!(info.fingerprint(&store_dir).starts_with("1;/nix/store/"));

Structs§

Field
An unrecognized .narinfo field retained for forward compatibility.
NarInfo
A parsed Nix binary-cache metadata record.
NarInfoBuilder
Builder for a validated NarInfo value.
NixSignature
A named, base64-encoded Nix Ed25519 signature.
Realisation
A derivation-output key paired with its realised value.
TrustedPublicKey
A named trusted Ed25519 public key.
UnkeyedRealisation
The unkeyed value stored in a binary cache’s .doi file.

Enums§

BuildError
Failure to construct a canonically serializable NarInfo value.
Compression
The compression named by a .narinfo record.
KeyError
Failure to parse a trusted public key.
ParseError
Failure to parse or validate a .narinfo record.
RealisationParseError
Failure to parse a derivation-output realisation.
SignatureError
Failure to decode or verify a Nix signature.

Constants§

MAX_NARINFO_SIZE
Maximum accepted .narinfo record size: one mebibyte.
MAX_REALISATION_SIZE
Maximum accepted realisation JSON size: one mebibyte.
REALISATIONS_PREFIX
Binary-cache directory containing derivation-output realisations.

Functions§

realisation_cache_path
Return the relative binary-cache key for a derivation output’s .doi file.

Type Aliases§

NarInfoSignature
Backwards-compatible name for a Nix signature attached to a .narinfo.