Struct ServerClient

pub struct ServerClient {
    pub api: String,
    pub client: Client,
    /* private fields */
}

Client to communicate with the LanguageTool server using async requests.

Fields

api: String

API string: hostname and, optionally, port number (see ServerCli).

client: Client

Reqwest client that can send requests to the server.

Implementations

impl ServerClient

pub fn new(hostname: &str, port: &str) -> Self

Construct a new server client using hostname and (optional) port

An empty string is accepeted as empty port. For port validation, please use parse_port as this constructor does not check anything.

pub fn with_max_suggestions(self, max_suggestions: isize) -> Self

Set the maximum number of suggestions (defaults to -1), a negative number will keep all replacement suggestions.

pub fn from_cli(cli: ServerCli) -> Self

Convert a ServerCli into a proper (usable) client.

pub async fn check(&self, request: &CheckRequest) -> Result<CheckResponse>

Send a check request to the server and await for the response.

pub async fn check_multiple_and_join( &self, requests: Vec<CheckRequest>, ) -> Result<CheckResponse>

Available on crate feature multithreaded only.

Send multiple check requests and join them into a single response.

Error

If any of the requests has self.text field which is none.

pub async fn annotate_check( &self, request: &CheckRequest, origin: Option<&str>, color: bool, ) -> Result<String>

Available on crate feature annotate only.

Send a check request to the server, await for the response and annotate it.

pub async fn languages(&self) -> Result<LanguagesResponse>

Send a languages request to the server and await for the response.

pub async fn words(&self, request: &WordsRequest) -> Result<WordsResponse>

Send a words request to the server and await for the response.

pub async fn words_add( &self, request: &WordsAddRequest, ) -> Result<WordsAddResponse>

Send a words/add request to the server and await for the response.

pub async fn words_delete( &self, request: &WordsDeleteRequest, ) -> Result<WordsDeleteResponse>

Send a words/delete request to the server and await for the response.

pub async fn ping(&self) -> Result<u128>

Ping the server and return the elapsed time in milliseconds if the server responded.

impl ServerClient

pub fn from_env() -> Result<Self>

Create a new ServerClient instance from environ variables.

See ServerCli::from_env for more details.

pub fn from_env_or_default() -> Self

Create a new ServerClient instance from environ variables, but defaults to ServerClient::default if expected environ variables are not set.

Trait Implementations

impl Clone for ServerClient

fn clone(&self) -> ServerClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerClient

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

Formats the value using the given formatter.

impl Default for ServerClient

fn default() -> Self

Returns the “default value” for a type.

impl From<ServerCli> for ServerClient

fn from(cli: ServerCli) -> Self

Converts to this type from the input type.