Struct parsoid::prelude::ParsoidClient

pub struct ParsoidClient { /* private fields */ }

Available on crate feature http only.

HTTP client to get Parsoid HTML from MediaWiki’s Rest APIs

Note: This requires the http feature is enabled (it is by default).

Implementations

impl Client

pub fn new(base_url: &str, user_agent: &str) -> Result<Self>

Create a new Client. base_url should either point to rest.php or Restbase. For Wikimedia projects it would look something like: https://en.wikipedia.org/api/rest_v1. For other wikis it might be: https://wiki.example.org/rest.php/wiki.example.org/v3.

(Note: no trailing slash on either endpoint style.)

pub fn new_with_client(base_url: &str, http: HttpClient) -> Self

Create a new Client using an existing reqwest::Client. See the documentation for new() for what base_url should be. This is primarily useful when you are already making calls to the wiki and want to share connection pools and cookie state.

pub async fn get(&self, page: &str) -> Result<ImmutableWikicode>

Get a Wikicode instance for the specified page

pub async fn get_revision( &self, page: &str, revid: u64 ) -> Result<ImmutableWikicode>

Get a Wikicode instance for the specified page at the specified revision

pub async fn get_raw(&self, page: &str) -> Result<String>

Get the Parsoid HTML for the specified page

pub async fn get_revision_raw(&self, page: &str, revid: u64) -> Result<String>

Get the Parsoid HTML for the specified page at the specified revision

pub async fn transform_to_html( &self, wikitext: &str ) -> Result<ImmutableWikicode>

Get a Wikicode instance for the specified wikitext

pub async fn transform_to_html_raw(&self, wikitext: &str) -> Result<String>

Get the Parsoid HTML for the specified wikitext

pub async fn transform_to_wikitext<C: APICode>( &self, code: &C ) -> Result<String>

Get the wikitext for the specified Parsoid HTML

pub async fn transform_to_wikitext_raw( &self, html: &str, title: Option<&str>, revid: Option<u64>, etag: Option<&str> ) -> Result<String>

Get the wikitext for the specified Parsoid HTML

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

Formats the value using the given formatter.