Skip to main content

MonolingualDictionaryService

Struct MonolingualDictionaryService 

Source
pub struct MonolingualDictionaryService {
    client: MonolingualClient,
    db: Db,
    dict_dir: PathBuf,
    pending_installs: Arc<Mutex<HashSet<String>>>,
}
Expand description

Provides monolingual dictionary management: querying available dictionaries, listing installed ones, and downloading + extracting new ones.

All network metadata is cached in the application SQLite database. Downloaded dictionaries are extracted to <dict_dir>/reader-dict/<lang>/.

The service is cheaply cloneable (Arc-backed). All clones share the same pending_installs set, so concurrent-download guards work correctly across the UI thread (which holds the original) and background threads (which hold clones).

Fields§

§client: MonolingualClient§db: Db§dict_dir: PathBuf§pending_installs: Arc<Mutex<HashSet<String>>>

Implementations§

Source§

impl MonolingualDictionaryService

Source

pub fn new( database: &Database, dict_dir: &Path, ) -> Result<Self, MonolingualError>

Creates a new service.

§Arguments
  • database - Application SQLite database used for metadata caching.
  • dict_dir - Root directory where dictionaries are stored. Downloads are placed in <dict_dir>/reader-dict/<lang>/.
§Errors

Returns an error if the HTTP client cannot be built.

Source

pub fn get_available_dictionaries( &self, ) -> Result<Vec<(String, DictionaryEntry)>, MonolingualError>

Returns all dictionaries available for download from the remote API.

Metadata is served from the SQLite cache when available; otherwise a network request is made and the result is cached.

§Errors

Returns an error if the metadata cannot be loaded from cache or network.

Source

pub fn get_entry_for_lang( &self, lang: &str, ) -> Result<Option<DictionaryEntry>, MonolingualError>

Returns the cached metadata entry for a single language.

This does not make any network requests. Returns None if no entry for lang has been cached yet.

§Errors

Returns an error if the database read fails.

Source

pub fn get_installed_dictionaries( &self, ) -> Result<Vec<String>, MonolingualError>

Returns the language codes of all locally installed dictionaries.

A dictionary is considered installed when its language directory exists inside <dict_dir>/reader-dict/ and contains at least one .index file paired with a .dict or .dict.dz file.

§Errors

Returns an error if the directory cannot be read.

Source

pub fn is_installing(&self, lang: &str) -> bool

Returns true if a download is already in progress for lang.

This can be used by callers to suppress duplicate install requests before spawning a background thread.

Source

pub fn install_dictionary<F>( &self, lang: &str, entry: &DictionaryEntry, include_etymologies: bool, progress_callback: &mut F, ) -> Result<(), MonolingualError>
where F: FnMut(u64, u64),

Downloads and installs a dictionary for the given language.

The archive is downloaded to a temporary file, then extracted into <dict_dir>/reader-dict/<lang>/ and the files are renamed to Reader-Dict-<lang>.index and Reader-Dict-<lang>.dict[.dz]. Any existing files in that directory are overwritten.

Returns MonolingualError::InstallationInProgress immediately if a download for the same language is already running. The caller should check Self::is_installing on the UI thread before spawning a thread to get a user-visible early exit; this check inside install_dictionary provides a safety net against races.

§Arguments
  • entry - Metadata entry for the dictionary to install. The language code and version are derived from this entry.
  • include_etymologies - When true, the full archive (with etymologies) is downloaded; when false, the smaller no-etymology variant is used.
  • progress_callback - Called after each downloaded chunk with (bytes_downloaded_so_far, total_bytes).
§Errors

Returns an error if a download for the language is already in progress, if the download fails, if the archive cannot be parsed, or if files cannot be written to disk.

Source

fn do_install<F>( &self, lang: &str, entry: &DictionaryEntry, include_etymologies: bool, progress_callback: &mut F, ) -> Result<(), MonolingualError>
where F: FnMut(u64, u64),

Source

pub fn remove_installed(&self, lang: &str)

Removes the installed dictionary record for lang from the database.

Logs a warning on failure rather than propagating the error, as this is a best-effort cleanup step called from event handlers.

Source

pub fn is_update_available(&self, lang: &str) -> bool

Returns true if a newer version of the dictionary for lang is available on the server than the currently installed version.

Returns false on any error to avoid surfacing spurious update badges.

Source

fn load_metadata( &self, ) -> Result<HashMap<String, HashMap<String, DictionaryEntry>>, MonolingualError>

Source

fn fetch_and_cache_metadata( &self, ) -> Result<HashMap<String, HashMap<String, DictionaryEntry>>, MonolingualError>

Source

fn get_cached_metadata( &self, ) -> Result<Option<HashMap<String, HashMap<String, DictionaryEntry>>>, MonolingualError>

Source

fn reader_dict_dir(&self) -> PathBuf

Source

fn lang_dir(&self, lang: &str) -> PathBuf

Trait Implementations§

Source§

impl Clone for MonolingualDictionaryService

Source§

fn clone(&self) -> MonolingualDictionaryService

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MonolingualDictionaryService

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
§

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