Struct parsoid::Client

pub struct Client { /* fields omitted */ }

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 async fn get<'_, '_>(&'_ self, page: &'_ str) -> Result<Wikicode>

Get a Wikicode instance for the specified page

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

Get the Parsoid HTML for the specified page

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

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<'_, '_>(
    &'_ self,
    code: &'_ Wikicode
) -> Result<String>

Get the wikitext for the specified Parsoid HTML

pub async fn transform_to_wikitext_raw<'_, '_>(
    &'_ self,
    html: &'_ str
) -> Result<String>

Get the wikitext for the specified Parsoid HTML