Struct mwbot::Page

pub struct Page { /* private fields */ }

A Page represents a wiki page on a specific wiki (Bot). You can get metadata about a page, its contents (in HTML or wikitext) and edit the page.

Pages are obtained by calling bot.page("<title>")?. Each page is Sync and designed to easily Cloned so it can be sent across multiple threads for concurrent processing.

Most metadata lookups are internally batched and cached so it might not reflect the live state on the wiki if someone has edited or modified the page in the meantime. To get fresh information create a new Page instance.

Saving a page will respect {{nobots}} (if not disabled), wait as needed for the configured rate limit and automatically implement edit conflict detection.

Implementations

impl Page

pub fn title(&self) -> &str

Get the title of the page

pub fn as_title(&self) -> &Title

Get a reference to the underlying mwtitle::Title

pub fn namespace(&self) -> i32

Get the namespace ID of the page

pub fn is_file(&self) -> bool

Whether this page refers to a file

pub fn as_file(&self) -> Option<File>

Available on crate feature upload only.

If it is a file, get a File instance

pub fn is_category(&self) -> bool

Whether this page refers to a category

pub async fn exists(&self) -> Result<bool>

Whether the page exists or not

pub async fn id(&self) -> Result<Option<u32>>

Get the page’s internal database ID, if it exists

pub async fn url(&self) -> Result<&str>

Get the canonical URL for this page

pub async fn is_redirect(&self) -> Result<bool>

Whether the page is a redirect or not

pub async fn associated_page(&self) -> Result<Page>

The associated page for this page (subject page for a talk page or talk page for a subject page)

pub async fn touched(&self) -> Result<Option<Timestamp>>

Get the “touched” timestamp, if the page exists.

From the MediaWiki documentation:

This timestamp is updated whenever the page changes in a way requiring it to be re-rendered, invalidating caches. Aside from editing, this includes permission changes, creation or deletion of linked pages, and alteration of contained templates.

pub async fn latest_revision_id(&self) -> Result<Option<u64>>

Get the ID of the latest revision, if the page exists.

pub async fn redirect_target(&self) -> Result<Option<Page>>

If this page is a redirect, get the Page it targets

pub async fn language_links(&self) -> Result<Option<HashMap<String, String>>>

Available on crate feature generators only.

Get the inter-language links of the latest revision, if the page exists.

pub async fn categories(&self) -> Result<Option<Vec<String>>>

Available on crate feature generators only.

Get the categories of the latest revision, if the page exists.

pub async fn html(&self) -> Result<ImmutableWikicode>

Get Parsoid HTML for self.baserevid if it’s set, or the latest revision otherwise

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

Get Parsoid HTML for the specified revision

pub async fn wikitext(&self) -> Result<String>

Get wikitext for self.baserevid if it’s set, or the latest revision otherwise

pub async fn save<S: Into<Saveable>>( self, edit: S, opts: &SaveOptions ) -> Result<(Page, EditResponse)>

Save the page using the specified HTML

pub async fn undo( self, from: u64, to: Option<u64>, opts: &SaveOptions ) -> Result<(Page, EditResponse)>

Reverses edits to revision IDs from through to. If to is passed None, only one revision specified in from will be undone.

Trait Implementations

impl Clone for Page

fn clone(&self) -> Page

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Page

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

Formats the value using the given formatter.

impl Display for Page

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

Formats the value using the given formatter.