Skip to main content

DictionaryIndexTask

Struct DictionaryIndexTask 

Source
pub struct DictionaryIndexTask {
    database: Database,
}
Expand description

Indexes .index dictionary files into SQLite for fast word lookups.

On each startup the task resumes from where it left off, so large dictionaries are indexed incrementally across restarts.

Fields§

§database: Database

Implementations§

Source§

impl DictionaryIndexTask

Source

pub fn new(database: Database) -> Self

Creates a new DictionaryIndexTask.

Source

fn detect_metadata(path_str: &str) -> (bool, bool)

Detects dictionary metadata by scanning the first lines of the .index file for 00-database-allchars and 00-database-case-sensitive entries.

Returns (case_sensitive, all_chars).

Source

fn resolve_index_state( &self, index_path: &Path, path_str: &str, fp_str: &str, ) -> Option<(i64, u64, u64, bool)>

Queries or initialises the metadata row for fp_str, returning (dict_id, skip_lines, total_lines).

Returns None when the file is already fully indexed or a DB error occurs, signalling that index_file should skip this file.

Source

fn mark_completed( &self, dict_id: i64, path_str: &str, current_line: u64, total_lines: u64, )

Marks the dictionary as fully indexed in the metadata table.

Source

fn parse_index_line<'a>( path_str: &str, line: &'a str, ) -> Option<(&'a str, i64, i64)>

Parses one tab-separated line from a .index file.

Returns None for lines that cannot be decoded. On decode failure a tracing error is emitted so the caller can skip the line without losing diagnostic info. Metadata lines such as 00-database-* are parsed normally so they are indexed and available for dictionary metadata queries.

Source

fn scan_and_batch( &self, job: &IndexFileJob<'_>, skip_lines: u64, hub: &Sender<Event>, shutdown: &ShutdownSignal, ) -> Option<u64>

Drives the line-by-line scan of an open index file, collecting entries into batches and flushing them to the database.

Returns Some(current_line) when scanning completed normally, None when a flush error or shutdown cut it short.

Source

fn index_file( &self, index_path: &Path, hub: &Sender<Event>, shutdown: &ShutdownSignal, )

Source

fn flush_batch( &self, job: &IndexFileJob<'_>, batch: &[(i64, String, i64, i64, Option<String>)], current_line: u64, hub: &Sender<Event>, ) -> Result<(), Error>

Source

fn delete_stale_entries( &self, on_disk_fingerprints: &[String], hub: &Sender<Event>, shutdown: &ShutdownSignal, )

Removes index data for dictionaries that are no longer present on disk.

For each fingerprint in dictionary_index_meta that has no corresponding .index file in on_disk_fingerprints, this method marks the meta row as incomplete before deletion begins. This ensures that if the process is interrupted mid-deletion, the next startup does not treat a partially deleted dictionary as fully indexed. Entries are then removed in batches via delete_entries_for_dict, after which the meta row itself is deleted.

Trait Implementations§

Source§

impl BackgroundTask for DictionaryIndexTask

Source§

fn id(&self) -> TaskId

Returns the unique identifier for this task.
Source§

fn run(&mut self, hub: &Sender<Event>, shutdown: &ShutdownSignal)

Runs the task until shutdown is requested. Read more
Source§

fn stop(&mut self)

Called when the task is being stopped. 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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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