Crate htmlify

Trait used to generate HTML from Rust structures

It contains the following optional definitions:

// Defaults to an empty string
fn tag(&self) -> Cow<'static, str> { /* ... */ }
// Defaults to empty vec
fn attributes(&self) -> Vec<Attribute> { /* ... */ }
// Defaults to empty vec
fn inner_html(&self) -> Vec<Box<dyn Htmlify>> { /* ... */ }

The following method should not need to be implemented:

// Calls `as_raw_html` for each of the items returned by `inner_html`
fn inner_html_as_string(&self) -> String { /* ... */ }

The following definition also should not need to be implemented, but may on occasion be useful to override:

fn as_raw_html(&self) -> String 
{
    format!
    (
        "<{0} {2}> {1} </{0}>",
        self.tag(),
        self.inner_html_as_string(),
        self.attributes()
            .iter()
            .map(Attribute::to_string)
            .collect::<Vec<String>>()
            .join(" ")
    )
}

The web-sys feature may be enabled to allow access to the following default function:

fn as_element(&self) -> Option<web_sys::Element> { /* ... */ }

The yew feature may be enabled to allow access to the following default function:

fn as_yew_node(&self) -> Html { /* ... */ }

There are 4 other tools included in this crate:

• An Htmlify implementation for &str. This is a special case which simply returns the string itself when as_raw_html is called, and returns None when as_element is called. This is so text-content “leaves” can be represented. (and the default implementation of as_element understands this).
• An Attribute struct to store key-value pairs as strings, used specifically for element attributes. These use Cow<'static, str> to leave optimization details up to the implementor.
• The web-sys feature also fives access to an append_to_document_body function which takes any impl Htmlify and attempts to append it to the document body (through web_sys calls). This is here purely for convenience.
• If the yew feature is enabled, an as_yew_node function will also be available.

Modules

yew

Structs

Attribute

HTML Attribute wrapper, a simple key-value string pair

Traits

Htmlify

Trait used to generate HTML from Rust structures. See module-level documentation for more details.

Functions

append_to_document_body

Helper function which appends some impl Htmlify to the web_sys document body. Combined with the rest of this crate, may be used to generate the entire HTML body in arbitrary Rust-driven ways.