Struct mediawiki::title::Title

pub struct Title { /* fields omitted */ }

Title struct

Implementations

impl Title

pub fn new(title: &str, namespace_id: NamespaceID) -> Title

Constructor, where un-prefixed title and namespace are known. Assumes title has correct capitalization

pub fn new_from_full(full_title: &str, api: &Api) -> Self

Constructor, where full namespace-prefixed title is known. Uses Api to parse valid namespaces

pub fn new_from_api_result(data: &Value) -> Title

Constructor, used by Api::result_array_to_titles

pub fn namespace_id(&self) -> NamespaceID

Returns the namespace ID

pub fn namespace_name<'a>(&self, api: &'a Api) -> Option<&'a str>

Returns the canonical namespace text, based on the Api

pub fn local_namespace_name<'a>(&self, api: &'a Api) -> Option<&'a str>

Returns the local namespace text, based on the Api

pub fn with_underscores(&self) -> String

Returns the non-namespace-prefixed title, with underscores

pub fn pretty(&self) -> &str

Returns the non-namespace-prefixed title, with spaces instead of underscores

pub fn full_with_underscores(&self, api: &Api) -> Option<String>

Returns the namespace-prefixed title, with underscores

pub fn full_pretty(&self, api: &Api) -> Option<String>

Returns the namespace-prefixed title, with spaces instead of underscores

pub fn spaces_to_underscores(s: &str) -> String

Changes all spaces to underscores

pub fn underscores_to_spaces(s: &str) -> String

Changes all underscores to spaces

pub fn first_letter_uppercase(s: &str) -> String

Changes the first letter to uppercase. Enforces spaces instead of underscores.

pub fn toggle_talk(&mut self)

Changes this Title to refer to the other member of the corresponding article-talk page pair for this page. Won't change Special pages.

Examples

use mediawiki::title::Title;
let mut title1 = Title::new("Test", 0);
title1.toggle_talk();
assert_eq!(title1, Title::new("Test", 1));

let mut title2 = Title::new("Test", 1);
title2.toggle_talk();
assert_eq!(title2, Title::new("Test", 0));

let mut title3 = Title::new("Test", -1);
title3.toggle_talk();
assert_eq!(title3, Title::new("Test", -1));

pub fn into_toggle_talk(self) -> Self

Returns a new Title referring to the other member of the corresponding article-talk page pair for this page. Won't change Special pages.

Examples

use mediawiki::title::Title;
assert_eq!(Title::new("Test", 0).into_toggle_talk(),
    Title::new("Test", 1));

assert_eq!(Title::new("Test", 1).into_toggle_talk(),
    Title::new("Test", 0));

assert_eq!(Title::new("Test", -1).into_toggle_talk(),
    Title::new("Test", -1));

Trait Implementations

impl Clone for Title

pub fn clone(&self) -> Title

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Title

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

Formats the value using the given formatter.

impl Eq for Title

impl Hash for Title

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Title> for Title

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

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

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

This method tests for !=.

impl StructuralEq for Title

impl StructuralPartialEq for Title