Struct parsoid::node::WikiLink

pub struct WikiLink(_);

Represents an internal link ([[Foo|bar]])

let text = Wikicode::new_text("baz");
let link = WikiLink::new("Foo bar", &text);
assert_eq!(
    link.raw_target(),
    "./Foo_bar".to_string()
);
assert_eq!(
    link.target(),
    "Foo bar".to_string()
);
assert_eq!(
    link.text_contents(), "baz".to_string()
);
assert_eq!(
    link.to_string(),
    "<a href=\"./Foo_bar\" rel=\"mw:WikiLink\">baz</a>".to_string()
);

See the spec for more details.

Implementations

impl WikiLink

pub fn new(target: &str, text: &NodeRef) -> Self

Create a new wiki link

pub fn raw_target(&self) -> String

Get the raw link target, usually prefixed with ./

pub fn target(&self) -> String

Get the link target (basicall the page title)

pub fn set_target(&self, target: &str)

Set the link target.

Methods from Deref<Target = NodeRef>

pub fn inclusive_ancestors(&self) -> Ancestors

Return an iterator of references to this node and its ancestors.

pub fn ancestors(&self) -> Ancestors

Return an iterator of references to this node’s ancestors.

pub fn inclusive_preceding_siblings(&self) -> Rev<Siblings>

Return an iterator of references to this node and the siblings before it.

pub fn preceding_siblings(&self) -> Rev<Siblings>

Return an iterator of references to this node’s siblings before it.

pub fn inclusive_following_siblings(&self) -> Siblings

Return an iterator of references to this node and the siblings after it.

pub fn following_siblings(&self) -> Siblings

Return an iterator of references to this node’s siblings after it.

pub fn children(&self) -> Siblings

Return an iterator of references to this node’s children.

pub fn inclusive_descendants(&self) -> Descendants

Return an iterator of references to this node and its descendants, in tree order.

Parent nodes appear before the descendants.

Note: this is the NodeEdge::Start items from traverse().

pub fn descendants(&self) -> Descendants

Return an iterator of references to this node’s descendants, in tree order.

Parent nodes appear before the descendants.

Note: this is the NodeEdge::Start items from traverse().

pub fn traverse_inclusive(&self) -> Traverse

Return an iterator of the start and end edges of this node and its descendants, in tree order.

pub fn traverse(&self) -> Traverse

Return an iterator of the start and end edges of this node’s descendants, in tree order.

pub fn select(
    &self,
    selectors: &str
) -> Result<Select<Elements<Descendants>, Selectors>, ()>

Return an iterator of the inclusive descendants element that match the given selector list.

pub fn select_first(
    &self,
    selectors: &str
) -> Result<NodeDataRef<ElementData>, ()>

Return the first inclusive descendants element that match the given selector list.

pub fn serialize<W>(&self, writer: &mut W) -> Result<(), Error> where
    W: Write, 

Serialize this node and its descendants in HTML syntax to the given stream.

pub fn serialize_to_file<P>(&self, path: P) -> Result<(), Error> where
    P: AsRef<Path>, 

Serialize this node and its descendants in HTML syntax to a new file at the given path.

pub fn text_contents(&self) -> String

Return the concatenation of all text nodes in this subtree.

pub fn append(&self, new_child: NodeRef)

Append a new child to this node, after existing children.

The new child is detached from its previous position.

pub fn prepend(&self, new_child: NodeRef)

Prepend a new child to this node, before existing children.

The new child is detached from its previous position.

pub fn insert_after(&self, new_sibling: NodeRef)

Insert a new sibling after this node.

The new sibling is detached from its previous position.

pub fn insert_before(&self, new_sibling: NodeRef)

Insert a new sibling before this node.

The new sibling is detached from its previous position.

Methods from Deref<Target = Node>

pub fn data(&self) -> &NodeData

Return a reference to this node’s node-type-specific data.

pub fn as_element(&self) -> Option<&ElementData>

If this node is an element, return a reference to element-specific data.

pub fn as_text(&self) -> Option<&RefCell<String>>

If this node is a text node, return a reference to its contents.

pub fn as_comment(&self) -> Option<&RefCell<String>>

If this node is a comment, return a reference to its contents.

pub fn as_doctype(&self) -> Option<&Doctype>

If this node is a document, return a reference to doctype-specific data.

pub fn as_document(&self) -> Option<&DocumentData>

If this node is a document, return a reference to document-specific data.

pub fn parent(&self) -> Option<NodeRef>

Return a reference to the parent node, unless this node is the root of the tree.

pub fn first_child(&self) -> Option<NodeRef>

Return a reference to the first child of this node, unless it has no child.

pub fn last_child(&self) -> Option<NodeRef>

Return a reference to the last child of this node, unless it has no child.

pub fn previous_sibling(&self) -> Option<NodeRef>

Return a reference to the previous sibling of this node, unless it is a first child.

pub fn next_sibling(&self) -> Option<NodeRef>

Return a reference to the next sibling of this node, unless it is a last child.

pub fn detach(&self)

Detach a node from its parent and siblings. Children are not affected.

To remove a node and its descendants, detach it and drop any strong reference to it.

Trait Implementations

impl Clone for WikiLink

fn clone(&self) -> WikiLink

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WikiLink

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

Formats the value using the given formatter.

impl Deref for WikiLink

type Target = NodeRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<WikiLink> for Wikinode

fn from(node: WikiLink) -> Self

Performs the conversion.

impl WikinodeIterator for WikiLink

fn as_node(&self) -> &NodeRef

fn append(&self, code: &NodeRef)

Append a node as a child

fn prepend(&self, code: &NodeRef)

Prepend a node as a child

fn insert_after(&self, code: &NodeRef)

Insert a node after the current node, as a sibling

fn insert_before(&self, code: &NodeRef)

Insert a node before the current node, as a sibling

fn select(&self, selector: &str) -> Vec<Wikinode>

Select some wiki nodes

fn select_first(&self, selector: &str) -> Option<Wikinode>

Get the first element that matches the selector, if possible

fn filter_links(&self) -> Vec<WikiLink>

Get a list of all wikilinks ([[Foo|bar]])

fn filter_external_links(&self) -> Vec<ExtLink>

Get a list of all external links ([https://example.org/ Example])

fn filter_categories(&self) -> Vec<Category>

Get a list of all categories

fn filter_templates(&self) -> Result<Vec<Template>>

Get a list of templates

fn filter_parser_functions(&self) -> Result<Vec<Template>>

Get a list of parser functions.

fn iter_sections(&self) -> Vec<Section>

fn inclusive_ancestors(&self) -> WikinodeMap<Ancestors>

Return an iterator of references to this node and its ancestors.

fn ancestors(&self) -> WikinodeMap<Ancestors>

Return an iterator of references to this node’s ancestors.

fn inclusive_preceding_siblings(&self) -> WikinodeMap<Rev<Siblings>>

Return an iterator of references to this node and the siblings before it.

fn preceding_simblings(&self) -> WikinodeMap<Rev<Siblings>>

Return an iterator of references to this node’s siblings before it.

fn inclusive_following_siblings(&self) -> WikinodeMap<Siblings>

Return an iterator of references to this node and the siblings after it.

fn following_siblings(&self) -> WikinodeMap<Siblings>

Return an iterator of references to this node’s siblings after it.

fn children(&self) -> WikinodeMap<Siblings>

Return an iterator of references to this node’s children.

fn inclusive_descendants(&self) -> WikinodeMap<Descendants>

Return an iterator of references to this node and its descendants, in tree order. Parent nodes appear before the descendants.

fn descendants(&self) -> WikinodeMap<Descendants>

Return an iterator of references to this node’s descendants, in tree order. Parent nodes appear before the descendants.