Struct parsoid::inclusion::OnlyInclude

pub struct OnlyInclude { /* private fields */ }

Represents a onlyinclude tag (<onlyinclude>)

This tag is special as it spans multiple nodes, similar to templates. However, because of the way wikitext is written, it’s possible for onlyinclude tags to be unbalanced, crossing normal HTML tags.

There are a few gotchas to using this because of how the contents are tracked. You can only go through the descendant nodes using inclusive_descendants. It’s not possible to use a tree structure because there’s no guarantee the contents are balanced HTML nodes.

Mutating nodes inside the onlyinclude is straightforward, but trying to change the tag itself is complicated. Trying to detach and reattach the same OnlyInclude instance probably won’t work as expected. Instead it’s recommended to only attach OnlyInclude instances that you create.

let code = client.transform_to_html("foo<onlyinclude>bar</onlyinclude>baz").await?.into_mutable();
// Get the `OnlyInclude` instance
let onlyinclude = code.filter_onlyinclude()[0].clone();
assert_eq!(&onlyinclude.inclusive_descendants()[0].text_contents(), "bar");

See the spec for more details.

Implementations

impl OnlyInclude

pub fn new(contents: &NodeRef) -> Self

pub fn inclusive_descendants(&self) -> Vec<Wikinode>

Iterate through all the nodes between the onlyinclude opening and closing tags, recursively.

Trait Implementations

impl Clone for OnlyInclude

fn clone(&self) -> OnlyInclude

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OnlyInclude

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

Formats the value using the given formatter.

impl WikiMultinode for OnlyInclude

fn as_nodes(&self) -> Vec<NodeRef>

fn detach(&self)

Remove this from the document