Struct RenderOptions 

#[non_exhaustive]
pub struct RenderOptions {
    pub pretty: bool,
    pub xhtml_self_closing: bool,
    pub max_depth: Option<usize>,
    /* private fields */
}

How a node tree is turned into markup.

A value passed into the render call, never global state — two threads can render the same tree with different settings at the same time. There is deliberately no process-wide switch.

Examples

use molt::core::RenderOptions;
let compact = RenderOptions::compact();
let pretty = RenderOptions::pretty();
let four_spaces = RenderOptions::pretty().with_indent("    ");

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pretty: bool

When true, children go on their own lines and are indented.

xhtml_self_closing: bool

When true, void elements close with /> instead of >.

max_depth: Option<usize>

Elements nested deeper than this are not written. None (the default) writes any depth. See RenderOptions::with_max_depth.

Implementations

impl RenderOptions

pub fn compact() -> Self

Minified output on a single line. The default, and what you should ship.

pub fn pretty() -> Self

Indented, human-readable output.

pub fn with_indent(self, indent: impl AsRef<str>) -> Self

Sets the indentation string.

Only spaces and tabs are kept, and at most 16 of them; anything else is dropped. The indent is written verbatim at the start of every line, so a string with markup in it (renderWithIndent(untrusted) from JavaScript, say) would put that markup on every line of the page. An indent that is not whitespace is not an indent.

Examples

use molt::core::RenderOptions;
assert_eq!(RenderOptions::pretty().with_indent("\t").indent(), "\t");
assert_eq!(RenderOptions::pretty().with_indent("<script>").indent(), "");
assert_eq!(RenderOptions::pretty().with_indent("  <b> ").indent(), "   ");

pub fn indent(&self) -> &str

The indentation string for one level: spaces and tabs only.

pub fn with_max_depth(self, max_depth: usize) -> Self

Stops writing elements nested deeper than max_depth; the subtree is dropped.

Pretty output grows with the square of the depth (one indent per level on every line), so a tree whose depth comes from untrusted input can ask for gigabytes. This bounds it. Browsers flatten nesting beyond roughly 512 elements, so a limit of 512 or less loses nothing a page could show. Text and fragments do not count as a level.

Examples

use molt::prelude::*;
let tree = div().child(div().child(div().child(p().text("deep"))));
let shallow = RenderOptions::compact().with_max_depth(2);
assert_eq!(tree.render_with(&shallow), "<div><div></div></div>");

pub fn with_xhtml_self_closing(self, yes: bool) -> Self

Closes void elements with /> instead of >.

Trait Implementations

impl Clone for RenderOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderOptions

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

Formats the value using the given formatter.

impl Default for RenderOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for RenderOptions

impl PartialEq for RenderOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RenderOptions