Skip to main content

Content

Struct Content 

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

Full-text index over file contents.

Implementations§

Source§

impl Content

Source

pub fn open( path: &Path, extensions: Vec<String>, limits: Limits, ) -> Result<Self, Error>

Open, creating the schema if needed.

§Errors

Error::Open if the database cannot be opened or the schema cannot be created.

Source

pub fn is_full(&self) -> bool

Whether the index has reached its configured size ceiling.

The write-ahead log is counted because it is real space the index is using; ignoring it lets the database sit well over its cap between checkpoints.

Source

pub fn accepts(&self, path: &Path) -> bool

Whether this path is a candidate for content indexing.

Source

pub fn len(&self) -> usize

Number of indexed documents.

Source

pub fn is_empty(&self) -> bool

Whether the index holds no documents.

Source

pub fn index(&mut self, paths: &[PathBuf]) -> usize

Index paths, skipping anything unchanged since last time.

Returns how many documents were newly extracted. Callers run this off the interactive path.

Source

pub fn prune_missing(&mut self)

Drop documents whose files no longer exist.

Source

pub fn search(&self, query: &str) -> Result<Vec<Item>, Error>

Search document contents, ranked by BM25.

§Errors

Error::Query if the underlying FTS5 query fails.

Trait Implementations§

Source§

impl Debug for Content

Source§

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

Formats the value using the given formatter. Read more

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more