sift-core 0.5.0

Indexed regex search over codebases (library + grep-like CLI)
Documentation
//! Indexed search execution built on the public grep crates.

pub mod candidates;
pub mod emit;
pub mod filter;
pub mod options;
pub mod output;
pub mod pattern;
pub mod query;
pub mod request;
pub mod scan;

use thiserror::Error;

use emit::error::ExecutionError;
use filter::error::FilterError;
use output::error::OutputError;
use pattern::error::CompileError;

#[derive(Debug, Error)]
pub enum SearchError {
    #[error("search patterns must not be empty")]
    EmptyPatterns,

    #[error("regex build error: {0}")]
    RegexBuild(String),

    #[error("invalid max-count: 0 matches requested")]
    InvalidMaxCount,

    #[error("JSON output is only supported for standard search (not count or file-list modes)")]
    JsonOutputIncompatibleMode,

    #[error("JSON serialization error: {0}")]
    JsonSerialize(#[from] serde_json::Error),

    #[error("IO error: {0}")]
    Io(#[from] std::io::Error),

    #[error("ignore walk error: {0}")]
    Ignore(#[from] ignore::Error),
}

impl From<CompileError> for SearchError {
    fn from(e: CompileError) -> Self {
        match e {
            CompileError::RegexBuild(s) => Self::RegexBuild(s),
        }
    }
}

impl From<FilterError> for SearchError {
    fn from(e: FilterError) -> Self {
        match e {
            FilterError::RegexBuild(s) => Self::RegexBuild(s),
            FilterError::Ignore(e) => Self::Ignore(e),
        }
    }
}

impl From<OutputError> for SearchError {
    fn from(e: OutputError) -> Self {
        match e {
            OutputError::JsonOutputIncompatibleMode => Self::JsonOutputIncompatibleMode,
            OutputError::JsonSerialize(e) => Self::JsonSerialize(e),
            OutputError::Io(e) => Self::Io(e),
        }
    }
}

impl From<ExecutionError> for SearchError {
    fn from(e: ExecutionError) -> Self {
        match e {
            ExecutionError::InvalidMaxCount => Self::InvalidMaxCount,
            ExecutionError::Io(e) => Self::Io(e),
            ExecutionError::Ignore(e) => Self::Ignore(e),
        }
    }
}

pub use emit::stats::SearchStats;
pub use filter::{
    CandidateFilter, CandidateFilterConfig, GlobConfig, HiddenMode, IgnoreConfig, IgnoreSources,
    TypeDef, VisibilityConfig,
};
pub use options::{BinaryMode, CaseMode, SearchMatchFlags, SearchOptions};
pub use output::format::{ColumnLimit, ColumnOverflow};
pub use output::mode::{MatchEmissionMode, OutputEmission, SearchMode, ZeroCountMode};
pub use output::passthru::PassthruMode;
pub use output::style::{
    ColorChoice, FilenameMode, LineStyleFlags, PathDisplay, RecordTerminator, SearchLineStyle,
    SearchRecordStyle, SearchSeparators,
};
pub use output::{SearchOutput, SearchOutputFormat};
pub use pattern::PatternCompiler;
pub use query::Match;
pub use query::SearchQuery;
pub use request::{LinkTraversal, SearchCollection, WalkOptions};

#[derive(Debug)]
pub struct SearchOutcome {
    pub matched: bool,
    pub stats: Option<SearchStats>,
}