Enum IndexError 

#[non_exhaustive]
pub enum IndexError {
    Io(Error),
    IndexNotFound(PathBuf),
    InvalidPattern(String),
    CorruptIndex(String),
    PathOutsideRepo(PathBuf),
    FileTooLarge {
        path: PathBuf,
        size: u64,
    },
    LockConflict(PathBuf),
    OverlayFull {
        overlay_docs: usize,
        base_docs: usize,
    },
    DocIdOverflow {
        base_doc_count: u32,
        overlay_docs: usize,
    },
}

Errors returned by index operations.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Io(Error)

I/O error (file not found, permission denied, etc.)

IndexNotFound(PathBuf)

No index exists at the given index directory. Build one first (Index::build, or st index from the CLI).

InvalidPattern(String)

Invalid regex pattern.

CorruptIndex(String)

Index is corrupt and needs rebuilding.

PathOutsideRepo(PathBuf)

Path is outside the repository root.

FileTooLarge

File exceeds maximum indexable size.

Fields

path: PathBuf

Path to the file.

size: u64

Size of the file in bytes.

LockConflict(PathBuf)

Another process holds a conflicting lock on the index directory.

OverlayFull

Overlay has grown too large relative to the base index. Call Index::build() to perform a full reindex.

Fields

overlay_docs: usize

Current number of overlay documents.

base_docs: usize

Number of base documents at the time of the check.

DocIdOverflow

Document ID space exceeded u32::MAX.

Fields

base_doc_count: u32

Number of base documents already allocated.

overlay_docs: usize

Number of overlay documents requested on top of the base.

Trait Implementations

impl Debug for IndexError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for IndexError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for IndexError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for IndexError

fn from(err: Error) -> Self

Converts to this type from the input type.