Struct FileIndex 

pub struct FileIndex {
    pub entries: BTreeMap<String, FileCandidate>,
}

The files under one root, keyed by their path relative to it.

Fields

entries: BTreeMap<String, FileCandidate>

Implementations

impl FileIndex

pub fn scan(root: &Path, honour_gitignore: bool) -> FileIndex

Walk root once and index what is under it. honour_gitignore is the reader’s own preference, which the walker honours.

pub fn visible(&self, query: &str, limit: usize) -> Vec<FileCandidate>

The candidates query matches, best first, at most limit of them. The cap is the caller’s: a dropdown and a page want different ones.

Trait Implementations

impl Default for FileIndex

fn default() -> FileIndex

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileIndex

fn deserialize<__D>( __deserializer: __D, ) -> Result<FileIndex, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FileIndex

impl PartialEq for FileIndex

fn eq(&self, other: &FileIndex) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for FileIndex

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileIndex