Struct grammarbot::Client

pub struct Client { /* fields omitted */ }

The primary way to interact with the API.

Methods

impl Client

pub fn new(api_key: &str) -> Self

Create a new Client.

Currently it requires an API key. If you need one, sign up with GrammarBot.

let api_key = "your_api_key";
let client = Client::new(api_key);

pub fn check(&self, text: &str) -> Result<Response>

pub fn api_key(&mut self, api_key: &str) -> &mut Self

Set the API key for the client.

let client = Client::new(api_key).api_key(other_api_key);

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

Set the language for the client.

let client = Client::new(api_key).language("en-UK");

pub fn base(&mut self, base: &str) -> Result<&mut Self>

Set the base URL for the client.

let client = Client::new(api_key).base("http://pro.grammarbot.io");