Struct ConfigFile 

#[non_exhaustive]
pub struct ConfigFile {

    pub max_text_length: Option<isize>,
    pub max_text_hard_length: Option<isize>,
    pub secret_token_key: Option<isize>,
    pub max_check_time_millis: Option<isize>,
    pub max_errors_per_word_rate: Option<isize>,
    pub max_spelling_suggestions: Option<isize>,
    pub max_check_threads: Option<isize>,
    pub cache_size: Option<isize>,
    pub cache_ttl_seconds: Option<isize>,
    pub request_limit: Option<isize>,
    pub request_limit_in_bytes: Option<isize>,
    pub timeout_request_limit: Option<isize>,
    pub request_limit_period_in_seconds: Option<isize>,
    pub language_model: Option<PathBuf>,
    pub word2vec_model: Option<PathBuf>,
    pub fasttext_model: Option<PathBuf>,
    pub fasttext_binary: Option<PathBuf>,
    pub max_work_queue_size: Option<isize>,
    pub rules_file: Option<PathBuf>,
    pub warm_up: Option<bool>,
    pub blocked_referrers: Option<Vec<String>>,
    pub premium_only: Option<bool>,
    pub disable_rule_ids: Option<Vec<String>>,
    pub pipeline_caching: Option<bool>,
    pub max_pipeline_pool_size: Option<isize>,
    pub pipeline_expire_time_in_seconds: Option<isize>,
    pub pipeline_prewarming: Option<bool>,
    pub spellcheck_only: Option<HashMap<String, String>>,
}

A Java property file (one key = value entry per line) with values listed below.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_text_length: Option<isize>

Maximum text length, longer texts will cause an error (optional).

max_text_hard_length: Option<isize>

Maximum text length, applies even to users with a special secret ‘token’ parameter (optional).

secret_token_key: Option<isize>

Secret JWT token key, if set by user and valid, maxTextLength can be increased by the user (optional).

max_check_time_millis: Option<isize>

Maximum time in milliseconds allowed per check (optional).

max_errors_per_word_rate: Option<isize>

Checking will stop with error if there are more rules matches per word (optional).

max_spelling_suggestions: Option<isize>

Only this many spelling errors will have suggestions for performance reasons (optional, affects Hunspell-based languages only).

max_check_threads: Option<isize>

Maximum number of threads working in parallel (optional).

cache_size: Option<isize>

Size of internal cache in number of sentences (optional, default: 0).

cache_ttl_seconds: Option<isize>

How many seconds sentences are kept in cache (optional, default: 300 if ‘cacheSize’ is set).

request_limit: Option<isize>

Maximum number of requests per requestLimitPeriodInSeconds (optional).

request_limit_in_bytes: Option<isize>

Maximum aggregated size of requests per requestLimitPeriodInSeconds (optional).

timeout_request_limit: Option<isize>

Maximum number of timeout request (optional).

request_limit_period_in_seconds: Option<isize>

Time period to which requestLimit and timeoutRequestLimit applies (optional).

language_model: Option<PathBuf>

A directory with ‘1grams’, ‘2grams’, ‘3grams’ sub directories which contain a Lucene index each with ngram occurrence counts; activates the confusion rule if supported (optional).

word2vec_model: Option<PathBuf>

A directory with word2vec data (optional), see https://github.com/languagetool-org/languagetool/blob/master/languagetool-standalone/CHANGES.md#word2vec.

fasttext_model: Option<PathBuf>

A model file for better language detection (optional), see https://fasttext.cc/docs/en/language-identification.html.

fasttext_binary: Option<PathBuf>

Compiled fasttext executable for language detection (optional), see https://fasttext.cc/docs/en/support.html.

max_work_queue_size: Option<isize>

Reject request if request queue gets larger than this (optional).

rules_file: Option<PathBuf>

A file containing rules configuration, such as .langugagetool.cfg (optional).

warm_up: Option<bool>

Set to ‘true’ to warm up server at start, i.e. run a short check with all languages (optional).

blocked_referrers: Option<Vec<String>>

A comma-separated list of HTTP referrers (and ‘Origin’ headers) that are blocked and will not be served (optional).

premium_only: Option<bool>

Activate only the premium rules (optional).

disable_rule_ids: Option<Vec<String>>

A comma-separated list of rule ids that are turned off for this server (optional).

pipeline_caching: Option<bool>

Set to ‘true’ to enable caching of internal pipelines to improve performance.

max_pipeline_pool_size: Option<isize>

Cache size if ‘pipelineCaching’ is set.

pipeline_expire_time_in_seconds: Option<isize>

Time after which pipeline cache items expire.

pipeline_prewarming: Option<bool>

Set to ‘true’ to fill pipeline cache on start (can slow down start a lot).

spellcheck_only: Option<HashMap<String, String>>

Spellcheck-only languages: You can add simple spellcheck-only support for languages that LT doesn’t support by defining two optional properties:

• ‘lang-xx’ - set name of the language, use language code instead of ‘xx’, e.g. lang-tr=Turkish;

• ‘lang-xx-dictPath’ - absolute path to the hunspell .dic file, use language code instead of ‘xx’, e.g. lang-tr-dictPath=/path/to/tr.dic. Note that the same directory also needs to contain a common_words.txt file with the most common 10,000 words (used for better language detection).

Implementations

impl ConfigFile

pub fn write_to<T: Write>(&self, w: &mut T) -> Result<()>

Write the config file in a key = value format.

Trait Implementations

impl Clone for ConfigFile

fn clone(&self) -> ConfigFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigFile

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

Formats the value using the given formatter.

impl Default for ConfigFile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConfigFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConfigFile

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ConfigFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ConfigFile

impl StructuralPartialEq for ConfigFile