Struct broot::content_search::Needle

pub struct Needle { /* private fields */ }

a strict (non fuzzy, case sensitive) pattern which may be searched in file contents

Implementations

impl Needle

pub fn new(pat: &str, max_file_size: usize) -> Self

Examples found in repository

src/pattern/content_pattern.rs (line 28)

    pub fn new(pat: &str, max_file_size: usize) -> Self {
        Self { needle: Needle::new(pat, max_file_size) }
    }

pub fn is_empty(&self) -> bool

Examples found in repository

src/pattern/content_pattern.rs (line 36)

    pub fn is_empty(&self) -> bool {
        self.needle.is_empty()
    }

pub fn as_str(&self) -> &str

Examples found in repository

src/pattern/content_pattern.rs (line 32)

    pub fn as_str(&self) -> &str {
        self.needle.as_str()
    }

src/content_search/needle.rs (line 222)

    pub fn get_match<P: AsRef<Path>>(
        &self,
        hay_path: P,
        desired_len: usize,
    ) -> Option<ContentMatch> {
        let hay = match get_mmap(hay_path) {
            Ok(hay) => hay,
            _ => { return None; }
        };
        match self.search_mmap(&hay) {
            ContentSearchResult::Found { pos } => {
                Some(ContentMatch::build(&hay, pos, self.as_str(), desired_len))
            }
            _ => None,
        }
    }

pub fn search<P: AsRef<Path>>(&self, hay_path: P) -> Result<ContentSearchResult>

determine whether the file contains the needle

Examples found in repository

src/pattern/content_pattern.rs (line 47)

    pub fn score_of(&self, candidate: Candidate) -> Option<i32> {
        if !candidate.regular_file {
            return None;
        }
        match self.needle.search(candidate.path) {
            Ok(ContentSearchResult::Found { .. }) => Some(1),
            Ok(ContentSearchResult::NotFound) => None,
            Ok(ContentSearchResult::NotSuitable) => {
                None
            }
            Err(e) => {
                debug!("error while scanning {:?} : {:?}", &candidate.path, e);
                None
            }
        }
    }

    /// get the line of the first match, if any
    pub fn get_match_line_count(
        &self,
        path: &Path,
    ) -> Option<usize> {
        if let Ok(ContentSearchResult::Found { pos }) = self.needle.search(path) {
            line_count_at_pos(path, pos).ok()
        } else {
            None
        }
    }

pub fn get_match<P: AsRef<Path>>(
    &self,
    hay_path: P,
    desired_len: usize
) -> Option<ContentMatch>

this is supposed to be called only when it’s known that there’s a match

Examples found in repository

src/pattern/content_pattern.rs (line 77)

    pub fn get_content_match(
        &self,
        path: &Path,
        desired_len: usize,
    ) -> Option<ContentMatch> {
        self.needle.get_match(path, desired_len)
    }

Trait Implementations

impl Clone for Needle

fn clone(&self) -> Needle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Needle

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

Formats the value using the given formatter.