fff-search 0.8.1

Faboulous & Fast File Finder - a fast and extremely correct file finder SDK with typo resistance, SIMD, prefiltering, and more
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
87
88
89
90
91
92
93
94
95
96

use std::path::StripPrefixError;

#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum Error {
    #[error("Thread panicked")]
    ThreadPanic,
    #[error("Invalid path {0}")]
    InvalidPath(std::path::PathBuf),
    #[error(
        "Can not run certain FFF features in a file system root or home directories. Consider smaller per-project directories."
    )]
    FilesystemRoot(std::path::PathBuf),
    #[error("File picker not initialized")]
    FilePickerMissing,
    #[error("Failed to acquire lock for frecency")]
    AcquireFrecencyLock,
    #[error("Failed to acquire lock for items by provider")]
    AcquireItemLock,
    #[error("Failed to acquire lock for path cache")]
    AcquirePathCacheLock,
    #[error("Failed to create directory: {0}")]
    CreateDir(#[from] std::io::Error),
    #[error("Failed to remove database directory {path}: {source}")]
    RemoveDbDir {
        path: std::path::PathBuf,
        source: std::io::Error,
    },
    #[error("Something is wrong with the local db instance: {0}")]
    GenericDbError(#[from] heed::Error),
    #[error("Failed to open {db} database env: {source}")]
    EnvOpen {
        db: &'static str,
        #[source]
        source: heed::Error,
    },
    #[error("Failed to create {db} database: {source}")]
    DbCreate {
        db: &'static str,
        #[source]
        source: heed::Error,
    },
    #[error("Failed to open {db} database: {source}")]
    DbOpen {
        db: &'static str,
        #[source]
        source: heed::Error,
    },
    #[error("Failed to clear stale readers for {db} database: {source}")]
    DbClearStaleReaders {
        db: &'static str,
        #[source]
        source: heed::Error,
    },

    #[error("Failed to start read transaction for {db} database: {source}")]
    DbStartReadTxn {
        db: &'static str,
        #[source]
        source: heed::Error,
    },
    #[error("Failed to start write transaction for {db} database: {source}")]
    DbStartWriteTxn {
        db: &'static str,
        #[source]
        source: heed::Error,
    },
    #[error("Failed to read from {db} database: {source}")]
    DbRead {
        db: &'static str,
        #[source]
        source: heed::Error,
    },
    #[error("Failed to write to {db} database: {source}")]
    DbWrite {
        db: &'static str,
        #[source]
        source: heed::Error,
    },
    #[error("Failed to commit write transaction to {db} database: {source}")]
    DbCommit {
        db: &'static str,
        #[source]
        source: heed::Error,
    },
    #[error("Failed to start file system watcher: {0}")]
    FileSystemWatch(#[from] notify::Error),

    #[error("Expected a path to be child of another path: {0}")]
    StripPrefixError(#[from] StripPrefixError),

    #[error("libgit2 error occurred: {0}")]
    Git(#[from] git2::Error),
}

pub type Result<T> = std::result::Result<T, Error>;