Struct parsoid::Wikicode

pub struct Wikicode { /* private fields */ }

Container for HTML, usually represents the entire page

Implementations

impl Wikicode

pub fn new(body: &str) -> Self

Create a new Wikicode instance from raw Parsoid HTML.

pub fn new_node(tag: &str) -> Self

Create a new HTML node with the given tag

let node = Wikicode::new_node("b");
// Append your list items
node.append(&Wikicode::new_text("bolded text"));
assert_eq!(&node.to_string(), "<b>bolded text</b>")

pub fn new_text(text: &str) -> Self

Create a text node with the given contents

let node = Wikicode::new_text("foo bar");
assert_eq!(&node.to_string(), "foo bar");
// Tags will be escaped
let weird_node = Wikicode::new_text("foo <bar>");
assert_eq!(&weird_node.to_string(), "foo &lt;bar&gt;");

pub fn set_etag(&mut self, etag: &str)

Set the etag that came with this request. This allows Parsoid to preserve formatting and avoid dirty diffs when converting modified HTML back to wikitext.

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

Get the etag that was set on this Wikicode instance.

pub fn spec_version(&self) -> Option<String>

Get the HTML spec version for this document, if it’s available

pub fn revision_id(&self) -> Option<u64>

Get the revision id associated with the Parsoid HTML, if it has one.

pub fn title(&self) -> Option<String>

Get the title associated with the Parsoid HTML, if it has one.

pub fn redirect(&self) -> Option<Redirect>

pub fn text_contents(&self) -> String

Get a plain text representation of the Parsoid HTML with all markup stripped.

pub fn into_immutable(self) -> ImmutableWikicode

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 Wikicode

fn clone(&self) -> Wikicode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Wikicode

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

Formats the value using the given formatter.

impl Deref for Wikicode

type Target = NodeRef

The resulting type after dereferencing.

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

Dereferences the value.

impl From<ImmutableWikicode> for Wikicode

fn from(immutable: ImmutableWikicode) -> Self

Converts to this type from the input type.

impl From<Wikicode> for ImmutableWikicode

fn from(code: Wikicode) -> Self

Converts to this type from the input type.

impl From<Wikinode> for Wikicode

fn from(node: Wikinode) -> Self

Converts to this type from the input type.

impl PartialEq<Wikicode> for Wikicode

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl WikinodeIterator for Wikicode

fn as_node(&self) -> &NodeRef

fn filter_comments(&self) -> Vec<Comment>

Get a list of all comments (<!-- example -->)

fn append<N: WikiMultinode>(&self, code: &N)

Append a node as a child

fn prepend<N: WikiMultinode>(&self, code: &N)

Prepend a node as a child

fn insert_after<N: WikiMultinode>(&self, code: &N)

Insert a node after the current node, as a sibling

fn insert_before<N: WikiMultinode>(&self, code: &N)

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_images(&self) -> Vec<Image>

Get a list of all iamges

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 filter_noinclude(&self) -> Vec<NoInclude>

fn filter_onlyinclude(&self) -> Vec<OnlyInclude>

fn parent(&self) -> Option<Wikinode>

Return the parent node, if it has one

fn next_sibling(&self) -> Option<Wikinode>

Return the next sibling node, if it has one

fn previous_sibling(&self) -> Option<Wikinode>

Return the previous sibling node, if it has one

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.

impl Eq for Wikicode

impl StructuralEq for Wikicode

impl StructuralPartialEq for Wikicode