Struct languagetool_rust::check::CheckRequest

pub struct CheckRequest {

    pub raw: bool,
    pub text: Option<String>,
    pub data: Option<Data>,
    pub language: String,
    pub username: Option<String>,
    pub api_key: Option<String>,
    pub dicts: Option<Vec<String>>,
    pub mother_tongue: Option<String>,
    pub preferred_variants: Option<Vec<String>>,
    pub enabled_rules: Option<Vec<String>>,
    pub disabled_rules: Option<Vec<String>>,
    pub enabled_categories: Option<Vec<String>>,
    pub disabled_categories: Option<Vec<String>>,
    pub enabled_only: bool,
    pub level: Level,
}

LanguageTool POST check request.

The main feature - check a text with LanguageTool for possible style and grammar issues.

The structure below tries to follow as closely as possible the JSON API decribed here.

Fields

raw: bool

Available on crate features cli and annotate only.

If present, raw JSON output will be printed instead of annotated text.

text: Option<String>

The text to be checked. This or ‘data’ is required.

data: Option<Data>

The text to be checked, given as a JSON document that specifies what’s text and what’s markup. This or ‘text’ is required.

Markup will be ignored when looking for errors. Example text:

A <b>test</b>

JSON for the example text:

{"annotation":[
 {"text": "A "},
 {"markup": "<b>"},
 {"text": "test"},
 {"markup": "</b>"}
]}

If you have markup that should be interpreted as whitespace, like

in HTML, you can have it interpreted like this:

{"markup": "<p>", "interpretAs": "\n\n"}

The ‘data’ feature is not limited to HTML or XML, it can be used for any kind of markup. Entities will need to be expanded in this input.

language: String

A language code like en-US, de-DE, fr, or auto to guess the language automatically (see preferredVariants below).

For languages with variants (English, German, Portuguese) spell checking will only be activated when you specify the variant, e.g. en-GB instead of just en.

username: Option<String>

Set to get Premium API access: Your username/email as used to log in at languagetool.org.

api_key: Option<String>

Set to get Premium API access: your API key

dicts: Option<Vec<String>>

Comma-separated list of dictionaries to include words from; uses special default dictionary if this is unset

mother_tongue: Option<String>

A language code of the user’s native language, enabling false friends checks for some language pairs.

preferred_variants: Option<Vec<String>>

Comma-separated list of preferred language variants.

The language detector used with language=auto can detect e.g. English, but it cannot decide whether British English or American English is used. Thus this parameter can be used to specify the preferred variants like en-GB and de-AT. Only available with language=auto. You should set variants for at least German and English, as otherwise the spell checking will not work for those, as no spelling dictionary can be selected for just en or de.

enabled_rules: Option<Vec<String>>

IDs of rules to be enabled, comma-separated

disabled_rules: Option<Vec<String>>

IDs of rules to be disabled, comma-separated

enabled_categories: Option<Vec<String>>

IDs of categories to be enabled, comma-separated

disabled_categories: Option<Vec<String>>

IDs of categories to be disabled, comma-separated

enabled_only: bool

If true, only the rules and categories whose IDs are specified with enabledRules or enabledCategories are enabled.

level: Level

If set to picky, additional rules will be activated, i.e. rules that you might only find useful when checking formal text.

Implementations

impl CheckRequest

pub fn with_text(self, text: &str) -> Self

pub fn with_data(self, data: Data) -> Self

pub fn with_data_str(self, data: &str) -> Result<Self>

pub fn with_language(self, language: &str) -> Self

Trait Implementations

impl Args for CheckRequest

fn augment_args<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can update self.

impl CommandFactory for CheckRequest

fn into_app<'b>() -> Command<'b>

👎 Deprecated since 3.1.0:

Replaced with `CommandFactory::command

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> Command<'b>

👎 Deprecated since 3.1.0:

Replaced with `CommandFactory::command_for_update

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build a Command that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

Build a Command that can update self.

impl Debug for CheckRequest

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

Formats the value using the given formatter.

impl Default for CheckRequest

fn default() -> CheckRequest

Returns the “default value” for a type.

impl FromArgMatches for CheckRequest

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches(
    &mut self,
    __clap_arg_matches: &ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CheckRequest

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone, 

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error> where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone, 

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I) where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone, 

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error> where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone, 

Update from iterator, return Err on error.

impl Serialize for CheckRequest

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

Serialize this value into the given Serde serializer.