Skip to main content

Crate rdom_parser

Crate rdom_parser 

Source
Expand description

§rdom-parser — HTML-ish template parser for rdom-core

Turns a template string into a Dom<Ext> tree. The parseFromString equivalent for the rdom family of crates.

§Quick start

use rdom_parser::parse;
use rdom_core::Dom;

let (dom, ids): (Dom<()>, _) = parse(r#"
    <div class="hero" id="main">
        <h1>Welcome</h1>
        <p>Hello &amp; <strong>world</strong></p>
    </div>
"#).unwrap();

let div = ids.iter().find(|&&id| dom.node(id).tag_name() == Some("div")).unwrap();
assert!(dom.node(*div).has_class("hero"));

§Supported

  • Start / end / self-closing tags, case-insensitive tag names
  • Void elements (<br>, <hr>, <img>, …) auto-close
  • Attributes: name="value", name='value', name=value, name (boolean). class="a b c" populates the classList.
  • Text with entity decoding: &amp; &lt; &gt; &quot; &apos; &nbsp; &#NNN; &#xHH;
  • Comments: <!-- … --> preserved as Comment nodes
  • Case-insensitive tag names (normalized to lowercase)
  • Attribute names preserved case

§Not supported (out of scope)

  • <!DOCTYPE> — no need for a TUI DOM
  • CDATA sections, namespace prefixes, processing instructions
  • <script> / <style> raw-text mode (our DOM doesn’t have these)
  • Mismatched tags are errors, not auto-repaired

§Error reporting

ParseError carries line/col/pos + optional hint:

let err = parse::<()>("<div><span></p></div>").unwrap_err();
assert!(err.msg.contains("mismatched"));
assert!(err.hint.is_some());

Structs§

ParseError
Parse error with position + optional hint.

Traits§

NodeMutHtml
HTML setters on NodeMut. Brings the innerHTML / outerHTML / insertAdjacentHTML ergonomics that rdom-core can’t expose directly (since it can’t depend on the parser).

Functions§

parse
Parse template into a fresh Dom<Ext> with a Fragment root. The returned ids are the top-level children of the fragment.
parse_into
Parse template and append the parsed tree under mount. Returns the ids of the top-level parsed nodes (direct children appended to mount). Does not alter existing children of mount.

Type Aliases§

Result
Result alias for parser operations.