Struct mwbot::ApiClient

pub struct ApiClient { /* private fields */ }

API Client

Implementations

impl Client

pub fn builder(api_url: &str) -> Builder

Get a Builder instance to further customize the API Client. The API URL should be the absolute path to api.php.

pub async fn new(api_url: &str) -> impl Future<Output = Result<Client, Error>>

Get an API Client instance. The API URL should be the absolute path to api.php.

pub async fn get_value<P>(
    &self,
    params: P
) -> impl Future<Output = Result<Value, Error>>where
    P: Into<Params>,

Same as get(), but return a serde_json::Value

pub async fn get<P, T>(
    &self,
    params: P
) -> impl Future<Output = Result<T, Error>>where
    P: Into<Params>,
    T: DeserializeOwned,

Make an arbitrary API request using HTTP GET.

pub async fn query_response<T, U, P>(
    &self,
    extra: P
) -> impl Future<Output = Result<T, Error>>where
    T: ApiResponse<U> + DeserializeOwned,
    P: Into<Params>,

Easily execute a request based on a mwapi_responses-generated struct.

Any extra custom parameters can be passed in to the function and were merged with the default request parameters.

pub async fn post_with_token<P, T>(
    &self,
    token_type: &str,
    params: P
) -> impl Future<Output = Result<T, Error>>where
    P: Into<Params>,
    T: DeserializeOwned,

Make an API POST request with a CSRF token. The correct token will automatically be fetched, and in case of a bad token error (if it expired), a new one will automatically be fetched and the request retried.

pub async fn post<P, T>(
    &self,
    params: P
) -> impl Future<Output = Result<T, Error>>where
    P: Into<Params>,
    T: DeserializeOwned,

Make an API POST request

pub async fn post_value<P>(
    &self,
    params: P
) -> impl Future<Output = Result<Value, Error>>where
    P: Into<Params>,

Same as post(), but return a serde_json::Value

pub async fn upload<P>(
    &self,
    filename: &str,
    path: PathBuf,
    chunk_size: usize,
    ignore_warnings: bool,
    params: P
) -> impl Future<Output = Result<String, Error>>where
    P: Into<Params>,

Upload a file under with the given filename from a path.

• The chunk_size should be in bytes, 5MB (5_000_000) is a reasonable default if you’re unsure.
• Warnings will be returned as an error unless ignore_warnings is true.
• Any extra parameters can be passed in the standard format.

pub fn http_client(&self) -> &Client

Get access to the underlying reqwest::Client to make arbitrary GET/POST requests, sharing the connection pool and cookie storage. For example, if you wanted to download images from the wiki.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.