dix 2.1.0

Diff Nix
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

use std::path::Path;

use eyre::{
  Context as _,
  Result,
};

use crate::{
  StorePath,
  store::{
    CombinedStoreBackend,
    StoreBackend,
    StorePathInfo,
  },
};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct StoreSnapshot {
  pub closure:  Vec<StorePathInfo>,
  pub selected: Vec<StorePath>,
}

/// Queries Nix store data for one path and returns a reusable snapshot.
///
/// # Errors
///
/// Returns an error if the store connection or path queries fail.
pub fn query_store_snapshot(
  path: &Path,
  force_correctness: bool,
) -> Result<StoreSnapshot> {
  CombinedStoreBackend::query_with_correctness(force_correctness, |backend| {
    query_store_snapshot_with_backend(backend, path)
  })
}

/// Queries Nix store data for one path using a caller-provided backend.
///
/// This does not call [`StoreBackend::connect`] or [`StoreBackend::close`].
/// Callers using connection-backed implementations must manage that lifecycle.
///
/// # Errors
///
/// Returns an error if the backend cannot query the path.
pub fn query_store_snapshot_with_backend(
  backend: &dyn StoreBackend,
  path: &Path,
) -> Result<StoreSnapshot> {
  tracing::debug!(path = %path.display(), "querying closure path info");
  let closure = backend.query_closure_path_info(path).with_context(|| {
    format!("failed to query closure path info of '{}'", path.display())
  })?;

  tracing::debug!(path = %path.display(), "querying system derivations");
  let selected = backend.query_system_derivations(path).with_context(|| {
    format!("failed to query system derivations of '{}'", path.display())
  })?;

  Ok(StoreSnapshot { closure, selected })
}