Skip to main content

Indexes

Struct Indexes 

Source
pub struct Indexes { /* private fields */ }
Expand description

Registry of opened indexes read from a snapshot store.

Implementations§

Source§

impl Indexes

Source

pub fn from_single(index: Index, root: PathBuf) -> Self

Create an Indexes registry from a single index and its root.

Useful for testing and benchmarking.

Source

pub fn open(sift_dir: &Path) -> Result<Self, IndexError>

Open all indexes found under sift_dir.

§Errors

Returns IndexError::InvalidManifest if a snapshot manifest is malformed, or IndexError::Trigram if a trigram index is malformed.

Returns an empty registry if no current snapshot exists (walk fallback).

Source

pub const fn is_empty(&self) -> bool

Source

pub fn root(&self) -> &Path

Source

pub fn resolve_candidates(&self, query: &QuerySpec<'_>) -> Vec<Candidate>

Resolve candidates for a query across all registered indexes.

Conservative sets from each [SearchIndex] are intersected using Candidate::rel_path equality (no hashing), so distinct paths are never merged by accident.

Source

pub fn candidates( &self, query: &QuerySpec<'_>, coverage: CandidateCoverage, ) -> Vec<Candidate>

Resolve candidates for a query, selecting narrowed or complete coverage.

Source

pub fn resolve_all_files(&self) -> Vec<Candidate>

Return all indexed files across all registered indexes.

Source

pub fn first(&self) -> Option<&Index>

Source

pub fn corpus_kind(&self) -> Option<CorpusKind>

Returns the corpus kind if all indexes agree, or None for mixed/empty.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.