ublx 0.1.3

TUI to index once, enrich with metadata, and browse a flat snapshot in a 3-pane layout with multiple modes.
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

use nefaxer::{Nefax, Result, nefax_dir, tuning_for_path};
use std::path::Path;

use log::{debug, error};

use crate::config::{UblxOpts, UblxSettings, parse_drive_type};
use crate::engine::db_ops;

pub type NefaxOpts = nefaxer::NefaxOpts;
pub type NefaxEntry = nefaxer::Entry;
pub type NefaxResult = nefaxer::Nefax;
pub type NefaxDiff = nefaxer::Diff;
pub type NefaxPathMeta = nefaxer::PathMeta;
pub type NefaxDriveType = nefaxer::disk_detect::DriveType;

fn nefax_opts_with_tuning(
    exclude: &[String],
    num_threads: usize,
    drive_type: NefaxDriveType,
    use_parallel_walk: bool,
) -> NefaxOpts {
    let mut opts = NefaxOpts {
        num_threads: Some(num_threads),
        drive_type: Some(drive_type),
        use_parallel_walk: Some(use_parallel_walk),
        ..NefaxOpts::default()
    };
    opts.exclude.extend(exclude.iter().map(ToString::to_string));
    opts
}

/// Build `NefaxOpts` for indexing `dir` with `exclude`. When `cached_settings` is `Some`, use those values and skip disk check; otherwise call [`tuning_for_path`](nefaxer::tuning_for_path).
#[must_use]
pub fn pre_opts_for_nefaxer(
    dir_to_ublx: &Path,
    exclude: &[String],
    cached_settings: Option<&UblxSettings>,
) -> NefaxOpts {
    let (num_threads, drive_type, use_parallel_walk) = match cached_settings {
        Some(s) => (
            s.num_threads,
            parse_drive_type(&s.drive_type),
            s.parallel_walk,
        ),
        None => tuning_for_path(dir_to_ublx, None),
    };
    nefax_opts_with_tuning(exclude, num_threads, drive_type, use_parallel_walk)
}

fn extract_nefax_opts_from_ublx_opts(opts: &UblxOpts) -> NefaxOpts {
    opts.nefax_opts_with_workers()
}

/// Run nefaxer; on success return `(nefax, diff)`, on error log and exit. Use when no cleanup is needed (e.g. sequential).
///
/// # Errors
///
/// Returns [`anyhow::Error`] when indexing fails (I/O, walk errors, etc.).
pub fn run_nefaxer<F>(
    dir_to_ublx: &Path,
    ublx_opts: &UblxOpts,
    nefax: Option<&Nefax>,
    entry_callback: Option<F>,
) -> Result<(NefaxResult, NefaxDiff)>
where
    F: FnMut(&NefaxEntry),
{
    let nefax_opts = extract_nefax_opts_from_ublx_opts(ublx_opts);
    nefax_dir(dir_to_ublx, &nefax_opts, nefax, entry_callback)
}

/// Load prior Nefax at startup. Exits the process on DB error; returns `None` when no prior snapshot exists.
#[must_use]
pub fn load_prior_nefax_or_exit(dir_to_ublx: &Path, db_path: &Path) -> Option<NefaxResult> {
    match db_ops::load_nefax_from_db(dir_to_ublx, db_path) {
        Ok(Some(nefax)) => {
            debug!("loaded {} paths from snapshot", nefax.len());
            Some(nefax)
        }
        Ok(None) => None,
        Err(e) => {
            error!("failed to load snapshot: {e}");
            crate::utils::exit_error();
        }
    }
}