Struct mwtitle::Title

pub struct Title { /* fields omitted */ }

Represents a MediaWiki title. A title can be broken down into the following attributes: [[interwiki:ns:db_key#fragment]].

• interwiki: Optional prefix pointing to another site
• namespace: Numerical ID corresponding to a MediaWiki namespace
• dbkey: Page name, with underscores instead of spaces
• fragment: Optional anchor for a specific section

// ns1 is Talk, so this is [[Talk:Main Page]]
let title = Title::new_unchecked(1, "Main_Page");
assert_eq!(title.namespace(), 1);
assert_eq!(title.dbkey(), "Main_Page");
assert!(title.interwiki().is_none());
assert!(title.fragment().is_none());
let title = title.with_fragment("Section 1");
assert_eq!(title.fragment(), Some("Section 1"));

Implementations

impl Title

pub fn new_unchecked(namespace: i32, text: &str) -> Self

Create a new Title, with no validation on the namespace or text parts. Good if you’re getting the title from a trusted place like the API. If the namespace does not exist in the TitleCodec this is used with it can result in panics.

Note that text is supposed to be the database key, with no namespace prefix.

pub fn with_fragment(self, fragment: &str) -> Self

Set a fragment.

pub fn remove_fragment(self) -> Self

Remove the fragment.

pub fn namespace(&self) -> i32

Get the namespace ID.

pub fn dbkey(&self) -> &str

Get the dbkey.

pub fn fragment(&self) -> Option<&str>

Get the fragment, if there is one.

pub fn interwiki(&self) -> Option<&str>

Get the interwiki, if there is one.

pub fn is_local_interwiki(&self) -> bool

Whether this title was created via a local interwiki link.

pub fn is_local_page(&self) -> bool

If the title is a local page that could exist, basically not an interwiki link, nor a fragment-only link, nor a special page.

pub fn is_file(&self) -> bool

Whether this title refers to a file.

pub fn is_category(&self) -> bool

Whether this title refers to a category.

Trait Implementations

impl Clone for Title

fn clone(&self) -> Title

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Title

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

Formats the value using the given formatter.

impl Ord for Title

fn cmp(&self, other: &Title) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Title> for Title

fn eq(&self, other: &Title) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Title) -> bool

This method tests for !=.

impl PartialOrd<Title> for Title

fn partial_cmp(&self, other: &Title) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Title

impl StructuralEq for Title

impl StructuralPartialEq for Title