Struct Builder

pub struct Builder { /* private fields */ }

Build a new API client.

let client: Client = Client::builder("https://example.org/w/api.php")
    .set_oauth2_token("foobar")
    .set_errorformat(mwapi::ErrorFormat::Html)
    .build().await?;

Implementations

impl Builder

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

Create a new Builder instance. Typically you will use Client::builder() instead.

pub async fn build(self) -> Result<Client>

Actually build the Client instance.

pub fn set_user_agent(self, user_agent: &str) -> Self

Set a custom User-agent. Ideally follow the Wikimedia User-agent policy.

pub fn set_oauth2_token(self, oauth2_token: &str) -> Self

Set an OAuth2 token for authentication

pub fn set_errorformat(self, errorformat: ErrorFormat) -> Self

Set the format error messages from the API should be in

pub fn set_concurrency(self, concurrency: usize) -> Self

Set how many requests should be processed in parallel. On Wikimedia wikis, you shouldn’t exceed the default of 1 without getting permission from a sysadmin.

pub fn set_maxlag(self, maxlag: u32) -> Self

Pause when the servers are lagged for how many seconds? Typically bots should set this to 5, while interactive usage should be much higher.

See mediawiki.org for more details.

pub fn set_retry_limit(self, limit: u32) -> Self

pub fn set_botpassword(self, username: &str, password: &str) -> Self

pub fn set_http_client<P>(self, provider: P) -> Self

where P: Into<HttpClientProvider>,

pub fn set_assert(self, assert: Assert) -> Self

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.