Struct mediawiki::api::Api

pub struct Api { /* fields omitted */ }

Api is the main class to interact with a MediaWiki API

Implementations

impl Api

pub async fn new(api_url: &str) -> Result<Api, Box<dyn Error>>

Returns a new Api element, and loads the MediaWiki site info from the api_url site. This is done both to get basic information about the site, and to test the API.

Examples

let api = mediawiki::api::Api::new("https://en.wikipedia.org/w/api.php").await.unwrap();

pub async fn new_from_builder(
    api_url: &str,
    builder: ClientBuilder
) -> Result<Api, Box<dyn Error>>

Returns a new Api element, and loads the MediaWiki site info from the api_url site. This is done both to get basic information about the site, and to test the API. Uses a bespoke reqwest::ClientBuilder.

pub fn api_url(&self) -> &str

Returns the API url

pub fn set_oauth(&mut self, oauth: Option<OAuthParams>)

Sets the OAuth parameters

pub fn set_oauth2(&mut self, oauth2: &str)

Set an OAuth 2 access token

pub fn oauth(&self) -> &Option<OAuthParams>

Returns a reference to the current OAuth parameters

pub fn client(&self) -> &Client

Returns a reference to the reqwest client

pub fn client_mut(&mut self) -> &mut Client

Returns a mutable reference to the reqwest client

pub fn user(&self) -> &User

Returns a reference to the current user object

pub fn user_mut(&mut self) -> &mut User

Returns a mutable reference to the current user object

pub async fn load_current_user_info(&mut self) -> Result<(), Box<dyn Error>>

Loads the current user info; returns Ok(()) is successful

pub fn max_retry_attempts(&self) -> u64

Returns the maximum number of retry attempts

pub fn set_max_retry_attempts(&mut self, max_retry_attempts: u64)

Sets the maximum number of retry attempts

pub fn get_site_info(&self) -> &Value

Returns a reference to the serde_json Value containing the site info

pub fn get_site_info_value<'a>(&'a self, k1: &str, k2: &str) -> &'a Value

Returns a serde_json Value in site info, within the ["query"] object.

pub fn get_site_info_string<'a>(
    &'a self,
    k1: &str,
    k2: &str
) -> Result<&'a str, String>

Returns a String from the site info, matching ["query"][k1][k2]

pub fn get_namespace_info(&self, namespace_id: NamespaceID) -> &Value

Returns the raw data for the namespace, matching ["query"]["namespaces"][namespace_id]

pub fn get_canonical_namespace_name(
    &self,
    namespace_id: NamespaceID
) -> Option<&str>

Returns the canonical namespace name for a namespace ID, if defined

pub fn get_local_namespace_name(
    &self,
    namespace_id: NamespaceID
) -> Option<&str>

Returns the local namespace name for a namespace ID, if defined

pub fn params_into(&self, params: &[(&str, &str)]) -> HashMap<String, String>

Turns a Vec of str tuples into a Hashmap of String, to be used in API calls

pub fn no_params(&self) -> HashMap<String, String>

Returns an empty parameter HashMap

pub async fn get_token(
    &mut self,
    token_type: &str
) -> Result<String, Box<dyn Error>>

Returns a token of a token_type, such as login or csrf (for editing)

pub async fn get_edit_token(&mut self) -> Result<String, Box<dyn Error>>

Calls get_token() to return an edit token

pub async fn get_query_api_json_all(
    &self,
    params: &HashMap<String, String>
) -> Result<Value, Box<dyn Error>>

Same as get_query_api_json but automatically loads all results via the continue parameter

pub async fn get_query_api_json_limit(
    &self,
    params: &HashMap<String, String>,
    max: Option<usize>
) -> Result<Value, Box<dyn Error>>

Same as get_query_api_json but automatically loads more results via the continue parameter

pub async fn get_query_api_json_limit_iter<'a>(
    &'a self,
    params: &HashMap<String, String>,
    max: Option<usize>
) -> impl Stream<Item = Result<Value, Box<dyn Error>>> + 'a

Same as get_query_api_json but automatically loads more results via the continue parameter. Returns a stream; each item is a "page" of results.

pub async fn query_api_json(
    &self,
    params: &HashMap<String, String>,
    method: &str
) -> Result<Value, Box<dyn Error>>

Runs a query against the MediaWiki API, using method GET or POST. Parameters are a hashmap; format=json is enforced.

pub fn edit_delay(&self) -> &Option<u64>

Returns the delay time after edits, in milliseconds, if set

pub fn set_edit_delay(&mut self, edit_delay_ms: Option<u64>)

Sets the delay time after edits in milliseconds (or None). This is independent of, and additional to, MAXLAG

pub fn maxlag(&self) -> &Option<u64>

Returns the maxlag, in seconds, if set

pub fn set_maxlag(&mut self, maxlag_seconds: Option<u64>)

Sets the maxlag in seconds (or None)

pub async fn get_query_api_json(
    &self,
    params: &HashMap<String, String>
) -> Result<Value, Box<dyn Error>>

GET wrapper for query_api_json

pub async fn post_query_api_json(
    &self,
    params: &HashMap<String, String>
) -> Result<Value, Box<dyn Error>>

POST wrapper for query_api_json

pub async fn post_query_api_json_mut(
    &mut self,
    params: &HashMap<String, String>
) -> Result<Value, Box<dyn Error>>

POST wrapper for query_api_json. Requires &mut self, for sassion cookie storage

pub async fn query_api_raw(
    &self,
    params: &HashMap<String, String>,
    method: &str
) -> Result<String, Box<dyn Error>>

Runs a query against the MediaWiki API, and returns a text. Uses query_raw

pub fn get_api_request_builder(
    &self,
    params: &HashMap<String, String>,
    method: &str
) -> Result<RequestBuilder, Box<dyn Error>>

Generates a RequestBuilder for the API URL

pub fn user_agent(&self) -> &str

Returns the user agent name

pub fn set_user_agent<S: Into<String>>(&mut self, agent: S)

Sets the user agent name

pub fn user_agent_full(&self) -> String

Returns the user agent string, as it is passed to the API through a HTTP header

pub async fn query_raw(
    &self,
    api_url: &str,
    params: &HashMap<String, String>,
    method: &str
) -> Result<String, Box<dyn Error>>

Runs a query against a generic URL, and returns a text. Does not store cookies, but also does not require &self to be mutable. Used for simple queries

pub async fn login<S: Into<String>>(
    &mut self,
    lgname: S,
    lgpassword: S
) -> Result<(), Box<dyn Error>>

Performs a login against the MediaWiki API. If successful, user information is stored in User, and in the cookie jar

pub fn result_array_to_titles(data: &Value) -> Vec<Title>

From an API result that has a list of entries with "title" and "ns" (e.g. search), returns a vector of Title objects.

pub async fn sparql_query(&self, query: &str) -> Result<Value, Box<dyn Error>>

Performs a SPARQL query against a wikibase installation. Tries to get the SPARQL endpoint URL from the site info

pub async fn sparql_query_endpoint(
    &self,
    query: &str,
    query_api_url: &str
) -> Result<Value, Box<dyn Error>>

Performs a SPARQL query against a wikibase installation. Uses the given sparql endpoint

pub fn extract_entity_from_uri(
    &self,
    uri: &str
) -> Result<String, Box<dyn Error>>

Given a uri (usually, an URL) that points to a Wikibase entity on this MediaWiki installation, returns the item ID

pub fn entities_from_sparql_result(
    &self,
    sparql_result: &Value,
    variable_name: &str
) -> Vec<String>

Returns a vector of entity IDs (as String) from a SPARQL result, given a variable name

pub async fn load_user_info(
    &self,
    user: &mut User
) -> Result<(), Box<dyn Error>>

Loads the user info from the API into the user structure

Trait Implementations

impl Clone for Api

pub fn clone(&self) -> Api

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Api

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

Formats the value using the given formatter.