orbok-fs 0.12.0

orbok safe file access boundary, source policy, scanner (RFC-003/RFC-004)
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

//! Shared fixtures for orbok-fs tests.

use orbok_core::{
    HiddenFilePolicy, IndexMode, PersistenceMode, SourceId, SourceType, SymlinkPolicy,
};
use orbok_db::Catalog;
use orbok_db::repo::{NewSource, SourceRecord, SourceRepository};
use std::path::Path;

/// Register a directory source over `root` with the safe defaults and
/// return its record.
pub fn register_dir_source(catalog: &Catalog, root: &Path) -> SourceRecord {
    register_dir_source_with(
        catalog,
        root,
        HiddenFilePolicy::Exclude,
        SymlinkPolicy::Ignore,
    )
}

pub fn register_dir_source_with(
    catalog: &Catalog,
    root: &Path,
    hidden: HiddenFilePolicy,
    symlink: SymlinkPolicy,
) -> SourceRecord {
    let canonical = std::fs::canonicalize(root).unwrap();
    SourceRepository::new(catalog)
        .insert(NewSource {
            source_type: SourceType::Directory,
            persistence_mode: PersistenceMode::Persistent,
            display_name: None,
            original_path: root.to_string_lossy().into_owned(),
            canonical_path: canonical.to_string_lossy().into_owned(),
            index_mode: IndexMode::Balanced,
            include_patterns: vec![],
            exclude_patterns: vec![],
            hidden_file_policy: hidden,
            symlink_policy: symlink,
            max_file_size_bytes: None,
        })
        .unwrap()
}

/// Scan helper with default request flags.
pub fn scan(catalog: &Catalog, source_id: &SourceId) -> crate::ScanSummary {
    let scanner = crate::Scanner::new(catalog);
    let cancel = std::sync::atomic::AtomicBool::new(false);
    scanner
        .scan(
            &crate::ScanRequest {
                source_id: source_id.clone(),
                force_hash: false,
                enqueue_index_jobs: true,
            },
            &cancel,
        )
        .unwrap()
}