Struct lol_html::html_content::Comment

pub struct Comment<'i> { /* fields omitted */ }

An HTML comment rewritable unit.

Exposes API for examination and modification of a parsed HTML comment.

Methods

impl<'i> Comment<'i>

pub fn text(&self) -> String

Returns the text of the comment.

pub fn set_text(&mut self, text: &str) -> Result<(), CommentTextError>

Sets the text of the comment.

pub fn before(&mut self, content: &str, content_type: ContentType)

Inserts content before the comment.

Consequent calls to the method append content to the previously inserted content.

Example

use lol_html::{rewrite_str, comments, RewriteStrSettings};
use lol_html::html_content::ContentType;

let html = rewrite_str(
    r#"<div><!-- foo --></div>"#,
    RewriteStrSettings {
        element_content_handlers: vec![
            comments!("div", |c| {
                c.before("<!-- 42 -->", ContentType::Html);
                c.before("bar", ContentType::Text);

                Ok(())
            })
        ],
        ..RewriteStrSettings::default()
    }
).unwrap();

assert_eq!(html, r#"<div><!-- 42 -->bar<!-- foo --></div>"#);

pub fn after(&mut self, content: &str, content_type: ContentType)

Inserts content after the comment.

Consequent calls to the method prepend content to the previously inserted content.

Example

use lol_html::{rewrite_str, comments, RewriteStrSettings};
use lol_html::html_content::ContentType;

let html = rewrite_str(
    r#"<div><!-- foo --></div>"#,
    RewriteStrSettings {
        element_content_handlers: vec![
            comments!("div", |c| {
                c.after("Bar", ContentType::Text);
                c.after("Qux", ContentType::Text);

                Ok(())
            })
        ],
        ..RewriteStrSettings::default()
    }
).unwrap();

assert_eq!(html, r#"<div><!-- foo -->QuxBar</div>"#);

pub fn replace(&mut self, content: &str, content_type: ContentType)

Replaces the comment with the content.

Consequent calls to the method overwrite previous replacement content.

Example

use lol_html::{rewrite_str, comments, RewriteStrSettings};
use lol_html::html_content::ContentType;

let html = rewrite_str(
    r#"<div><!-- foo --></div>"#,
    RewriteStrSettings {
        element_content_handlers: vec![
            comments!("div", |c| {
                c.replace("Bar", ContentType::Text);
                c.replace("Qux", ContentType::Text);

                Ok(())
            })
        ],
        ..RewriteStrSettings::default()
    }
).unwrap();

assert_eq!(html, r#"<div>Qux</div>"#);

pub fn remove(&mut self)

Removes the comment.

pub fn removed(&self) -> bool

Returns true if the comment has been replaced or removed.

Trait Implementations

impl<'_> Debug for Comment<'_>

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

Formats the value using the given formatter.

impl<'_> UserData for Comment<'_>

fn user_data(&self) -> &dyn Any

Returns a reference to the attached user data.

fn user_data_mut(&mut self) -> &mut dyn Any

Returns a mutable reference to the attached user data.

fn set_user_data(&mut self, data: impl Any)

Attaches user data to a rewritable unit.