Trait build_html::HtmlContainer

pub trait HtmlContainer: Html + Sized {
    pub fn add_html(self, html: Box<dyn Html>) -> Self;

    pub fn add_container(self, container: Container) -> Self { ... }
    pub fn add_table(self, table: Table) -> Self { ... }
    pub fn add_header<T: Display>(self, level: u8, text: T) -> Self { ... }
    pub fn add_header_attr<T: Display>(
        self, 
        level: u8, 
        text: T, 
        attr: HashMap<&str, &str>
    ) -> Self { ... }
    pub fn add_image(self, src: &str, alt: &str) -> Self { ... }
    pub fn add_image_attr(
        self, 
        src: &str, 
        alt: &str, 
        attr: HashMap<&str, &str>
    ) -> Self { ... }
    pub fn add_link<T: Display>(self, href: &str, text: T) -> Self { ... }
    pub fn add_link_attr<T: Display>(
        self, 
        href: &str, 
        text: T, 
        attr: HashMap<&str, &str>
    ) -> Self { ... }
    pub fn add_paragraph<T: Display>(self, text: T) -> Self { ... }
    pub fn add_paragraph_attr<T: Display>(
        self, 
        text: T, 
        attr: HashMap<&str, &str>
    ) -> Self { ... }
    pub fn add_preformatted<T: Display>(self, text: T) -> Self { ... }
    pub fn add_preformatted_attr<T: Display>(
        self, 
        text: T, 
        attr: HashMap<&str, &str>
    ) -> Self { ... }
}

An HTML element that can contain other HTML elements

This trait implements the majority of the specific "add x" methods, requiring implementors to add only one method: add_html()

Required methods

pub fn add_html(self, html: Box<dyn Html>) -> Self

Adds the specified HTML element to this container

This method should probably not be used directly by client programs. For most applications, the add_x() methods will provide more safety.

Loading content...

Provided methods

pub fn add_container(self, container: Container) -> Self

Nest the specified container within this container

Example

let content = Container::default()
    .add_header(1, "Content Outside")
    .add_container(
        Container::new(ContainerType::Main)
            .add_paragraph("Content Inside")
    )
    .to_html_string();

assert_eq!(
    content,
    "<div><h1>Content Outside</h1><main><p>Content Inside</p></main></div>"
);

pub fn add_table(self, table: Table) -> Self

Nest the specified Table within this container

Example

let content = Container::default()
    .add_table(
        Table::from(&[
            [1, 2, 3],
            [4, 5, 6]
        ])
        .add_header_row(&['A', 'B', 'C'])
    )
    .to_html_string();

assert_eq!(
    content,
    concat!(
        "<div><table><thead>",
        "<tr><th>A</th><th>B</th><th>C</th></tr>",
        "</thead><tbody>",
        "<tr><td>1</td><td>2</td><td>3</td></tr>",
        "<tr><td>4</td><td>5</td><td>6</td></tr>",
        "</tbody></table></div>"
    )
);

pub fn add_header<T: Display>(self, level: u8, text: T) -> Self

Adds a header tag with the designated level to this container

Example

let content = Container::default()
    .add_header(1, "Header Text")
    .to_html_string();

assert_eq!(content, r#"<div><h1>Header Text</h1></div>"#)

pub fn add_header_attr<T: Display>(
    self,
    level: u8,
    text: T,
    attr: HashMap<&str, &str>
) -> Self

Adds a header tag with the designated level and attributes to this container.

Example

let content = Container::default()
    .add_header_attr(1, "Header Text", hashmap! {"id" => "main-header"})
    .to_html_string();

assert_eq!(content, r#"<div><h1 id="main-header">Header Text</h1></div>"#)

pub fn add_image(self, src: &str, alt: &str) -> Self

Adds an <img> tag to this container

Example

let content = Container::default()
    .add_image("myimage.png", "a test image")
    .to_html_string();

assert_eq!(content, r#"<div><img src="myimage.png" alt="a test image"></div>"#)

pub fn add_image_attr(
    self,
    src: &str,
    alt: &str,
    attr: HashMap<&str, &str>
) -> Self

Adds an <img> tag with the specified attributes to this container

Example

let content = Container::default()
    .add_image_attr("myimage.png", "a test image", hashmap! {"id" => "sample-image"})
    .to_html_string();

assert_eq!(
    content,
    r#"<div><img src="myimage.png" alt="a test image" id="sample-image"></div>"#
)

pub fn add_link<T: Display>(self, href: &str, text: T) -> Self

Adds an <a> tag to this container

Example

let content = Container::default()
    .add_link("https://rust-lang.org/", "Rust Homepage")
    .to_html_string();

assert_eq!(content, r#"<div><a href="https://rust-lang.org/">Rust Homepage</a></div>"#)

pub fn add_link_attr<T: Display>(
    self,
    href: &str,
    text: T,
    attr: HashMap<&str, &str>
) -> Self

Adds an <a> tag with the specified attributes to this container

Example

let content = Container::default()
    .add_link_attr("https://rust-lang.org/", "Rust Homepage", hashmap! {"class" => "links"})
    .to_html_string();

assert_eq!(
    content,
    r#"<div><a href="https://rust-lang.org/" class="links">Rust Homepage</a></div>"#
)

pub fn add_paragraph<T: Display>(self, text: T) -> Self

Adds a <p> tag element to this Container

Example

let content = Container::default()
    .add_paragraph("This is sample paragraph text")
    .to_html_string();

assert_eq!(content, r#"<div><p>This is sample paragraph text</p></div>"#)

pub fn add_paragraph_attr<T: Display>(
    self,
    text: T,
    attr: HashMap<&str, &str>
) -> Self

Adds a <p> tag element with the specified attributes to this Container

Example

let content = Container::default()
    .add_paragraph_attr("This is sample paragraph text", hashmap! {"class" => "text"})
    .to_html_string();

assert_eq!(content, r#"<div><p class="text">This is sample paragraph text</p></div>"#)

pub fn add_preformatted<T: Display>(self, text: T) -> Self

Adds a <pre> tag element to this container

Example

let content = Container::default()
    .add_preformatted("This | is   preformatted => text")
    .to_html_string();

assert_eq!(content, r#"<div><pre>This | is   preformatted => text</pre></div>"#)

pub fn add_preformatted_attr<T: Display>(
    self,
    text: T,
    attr: HashMap<&str, &str>
) -> Self

Adds a <pre> tag element with the specified attributes to this container

Example

let content = Container::default()
    .add_preformatted_attr("This | is   preformatted => text", hashmap! {"id" => "code"})
    .to_html_string();

assert_eq!(content, r#"<div><pre id="code">This | is   preformatted => text</pre></div>"#)

Loading content...

Implementors

impl HtmlContainer for Container

pub fn add_html(mut self: Self, content: Box<dyn Html>) -> Self

impl HtmlContainer for HtmlPage

pub fn add_html(mut self: Self, html: Box<dyn Html>) -> Self

Loading content...