Struct html_builder::Node

pub struct Node<'a> { /* private fields */ }

An HTML element.

An open-tag is written to the buffer when a Node is created, and a close-tag is written when the Node is dropped. You can set attributes on a newly-created node using attr(), create child nodes with child(), and write text into the node using the Write impl.

Escaping

Text written into a node using its Write impl is transformed to make it render correctly in an HTML-context. By default, the following characters are escaped: &, <, and >. The escaping can be strengthened or weakened using the safe() and raw() methods respectively.

Implementations

impl<'a> Node<'a>

pub fn child<'b>(&'b mut self, tag: Cow<'static, str>) -> Node<'b>

pub fn void_child<'b>(&'b mut self, tag: Cow<'static, str>) -> Void<'b>

pub fn comment<'b>(&'b mut self) -> Comment<'b>

pub fn attr(self, attr: &str) -> Node<'a>

pub fn raw(self) -> Node<'a>

Disable escaping

In this mode, written text is passed through unmodified.

pub fn safe(self) -> Node<'a>

Escape more special characters

In this mode, the following characters are escaped: &, <, >, ", ', and /.

Trait Implementations

impl<'a> Html5 for Node<'a>

fn doctype(&mut self)

Defines the document type

fn a(&mut self) -> Node<'_>

Defines a hyperlink

fn abbr(&mut self) -> Node<'_>

Defines an abbreviation or an acronym

fn address(&mut self) -> Node<'_>

Defines contact information for the author/owner of a document

fn area(&mut self) -> Void<'_>

Defines an area inside an image map

fn article(&mut self) -> Node<'_>

Defines an article

fn aside(&mut self) -> Node<'_>

Defines content aside from the page content

fn audio(&mut self) -> Node<'_>

Defines embedded sound content

fn b(&mut self) -> Node<'_>

Defines bold text

fn base(&mut self) -> Void<'_>

Specifies the base URL/target for all relative URLs in a document

fn bdi(&mut self) -> Node<'_>

Isolates a part of text that might be formatted in a different direction from other text outside it

fn bdo(&mut self) -> Node<'_>

Overrides the current text direction

fn blockquote(&mut self) -> Node<'_>

Defines a section that is quoted from another source

fn body(&mut self) -> Node<'_>

Defines the document’s body

fn br(&mut self) -> Void<'_>

Defines a single line break

fn button(&mut self) -> Node<'_>

Defines a clickable button

fn canvas(&mut self) -> Node<'_>

Used to draw graphics, on the fly, via scripting (usually JavaScript)

fn caption(&mut self) -> Node<'_>

Defines a table caption

fn cite(&mut self) -> Node<'_>

Defines the title of a work

fn code(&mut self) -> Node<'_>

Defines a piece of computer code

fn col(&mut self) -> Void<'_>

Specifies column properties for each column within a <colgroup> element

fn colgroup(&mut self) -> Node<'_>

Specifies a group of one or more columns in a table for formatting

fn data(&mut self) -> Node<'_>

Adds a machine-readable translation of a given content

fn datalist(&mut self) -> Node<'_>

Specifies a list of pre-defined options for input controls

fn dd(&mut self) -> Node<'_>

Defines a description/value of a term in a description list

fn del(&mut self) -> Node<'_>

Defines text that has been deleted from a document

fn details(&mut self) -> Node<'_>

Defines additional details that the user can view or hide

fn dfn(&mut self) -> Node<'_>

Specifies a term that is going to be defined within the content

fn dialog(&mut self) -> Node<'_>

Defines a dialog box or window

fn div(&mut self) -> Node<'_>

Defines a section in a document

fn dl(&mut self) -> Node<'_>

Defines a description list

fn dt(&mut self) -> Node<'_>

Defines a term/name in a description list

fn em(&mut self) -> Node<'_>

Defines emphasized text

fn embed(&mut self) -> Void<'_>

Defines a container for an external application

fn fieldset(&mut self) -> Node<'_>

Groups related elements in a form

fn figcaption(&mut self) -> Node<'_>

Defines a caption for a <figure> element

fn figure(&mut self) -> Node<'_>

Specifies self-contained content

fn footer(&mut self) -> Node<'_>

Defines a footer for a document or section

fn form(&mut self) -> Node<'_>

Defines an HTML form for user input

fn h1(&mut self) -> Node<'_>

Defines HTML headings

fn h2(&mut self) -> Node<'_>

Defines HTML headings

fn h3(&mut self) -> Node<'_>

Defines HTML headings

fn h4(&mut self) -> Node<'_>

Defines HTML headings

fn h5(&mut self) -> Node<'_>

Defines HTML headings

fn h6(&mut self) -> Node<'_>

Defines HTML headings

fn head(&mut self) -> Node<'_>

Contains metadata/information for the document

fn header(&mut self) -> Node<'_>

Defines a header for a document or section

fn hr(&mut self) -> Void<'_>

Defines a thematic change in the content

fn html(&mut self) -> Node<'_>

Defines the root of an HTML document

fn i(&mut self) -> Node<'_>

Defines a part of text in an alternate voice or mood

fn iframe(&mut self) -> Node<'_>

Defines an inline frame

fn img(&mut self) -> Void<'_>

Defines an image

fn input(&mut self) -> Void<'_>

Defines an input control

fn ins(&mut self) -> Node<'_>

Defines a text that has been inserted into a document

fn kbd(&mut self) -> Node<'_>

Defines keyboard input

fn label(&mut self) -> Node<'_>

Defines a label for an <input> element

fn legend(&mut self) -> Node<'_>

Defines a caption for a <fieldset> element

fn li(&mut self) -> Node<'_>

Defines a list item

fn link(&mut self) -> Void<'_>

Defines the relationship between a document and an external resource (most used to link to style sheets)

fn main(&mut self) -> Node<'_>

Specifies the main content of a document

fn map(&mut self) -> Node<'_>

Defines an image map

fn mark(&mut self) -> Node<'_>

Defines marked/highlighted text

fn meta(&mut self) -> Void<'_>

Defines metadata about an HTML document

fn meter(&mut self) -> Node<'_>

Defines a scalar measurement within a known range (a gauge)

fn nav(&mut self) -> Node<'_>

Defines navigation links

fn noscript(&mut self) -> Node<'_>

Defines an alternate content for users that do not support client-side scripts

fn object(&mut self) -> Node<'_>

Defines a container for an external application

fn ol(&mut self) -> Node<'_>

Defines an ordered list

fn optgroup(&mut self) -> Node<'_>

Defines a group of related options in a drop-down list

fn option(&mut self) -> Node<'_>

Defines an option in a drop-down list

fn output(&mut self) -> Node<'_>

Defines the result of a calculation

fn p(&mut self) -> Node<'_>

Defines a paragraph

fn param(&mut self) -> Void<'_>

Defines a parameter for an object

fn picture(&mut self) -> Node<'_>

Defines a container for multiple image resources

fn pre(&mut self) -> Node<'_>

Defines preformatted text

fn progress(&mut self) -> Node<'_>

Represents the progress of a task

fn q(&mut self) -> Node<'_>

Defines a short quotation

fn rp(&mut self) -> Node<'_>

Defines what to show in browsers that do not support ruby annotations

fn rt(&mut self) -> Node<'_>

Defines an explanation/pronunciation of characters (for East Asian typography)

fn ruby(&mut self) -> Node<'_>

Defines a ruby annotation (for East Asian typography)

fn s(&mut self) -> Node<'_>

Defines text that is no longer correct

fn samp(&mut self) -> Node<'_>

Defines sample output from a computer program

fn script(&mut self) -> Node<'_>

Defines a client-side script

fn section(&mut self) -> Node<'_>

Defines a section in a document

fn select(&mut self) -> Node<'_>

Defines a drop-down list

fn small(&mut self) -> Node<'_>

Defines smaller text

fn source(&mut self) -> Void<'_>

Defines multiple media resources for media elements (<video> and <audio>)

fn span(&mut self) -> Node<'_>

Defines a section in a document

fn strong(&mut self) -> Node<'_>

Defines important text

fn style(&mut self) -> Node<'_>

Defines style information for a document

fn sub(&mut self) -> Node<'_>

Defines subscripted text

fn summary(&mut self) -> Node<'_>

Defines a visible heading for a <details> element

fn sup(&mut self) -> Node<'_>

Defines superscripted text

fn svg(&mut self) -> Node<'_>

Defines a container for SVG graphics

fn table(&mut self) -> Node<'_>

Defines a table

fn tbody(&mut self) -> Node<'_>

Groups the body content in a table

fn td(&mut self) -> Node<'_>

Defines a cell in a table

fn template(&mut self) -> Node<'_>

Defines a container for content that should be hidden when the page loads

fn textarea(&mut self) -> Node<'_>

Defines a multiline input control (text area)

fn tfoot(&mut self) -> Node<'_>

Groups the footer content in a table

fn th(&mut self) -> Node<'_>

Defines a header cell in a table

fn thead(&mut self) -> Node<'_>

Groups the header content in a table

fn time(&mut self) -> Node<'_>

Defines a specific time (or datetime)

fn title(&mut self) -> Node<'_>

Defines a title for the document

fn tr(&mut self) -> Node<'_>

Defines a row in a table

fn track(&mut self) -> Void<'_>

Defines text tracks for media elements (<video> and <audio>)

fn u(&mut self) -> Node<'_>

Defines some text that is unarticulated and styled differently from normal text

fn ul(&mut self) -> Node<'_>

Defines an unordered list

fn var(&mut self) -> Node<'_>

Defines a variable

fn video(&mut self) -> Node<'_>

Defines embedded video content

fn wbr(&mut self) -> Void<'_>

Defines a possible line-break

impl<'a> Write for Node<'a>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.