pub struct Comment<'i> { /* private fields */ }
Expand description

An HTML comment rewritable unit.

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

Implementations§

source§

impl<'i> Comment<'i>

source

pub fn text(&self) -> String

Returns the text of the comment.

source

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

Sets the text of the comment.

source

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>"#);
source

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>"#);
source

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>"#);
source

pub fn remove(&mut self)

Removes the comment.

source

pub fn removed(&self) -> bool

Returns true if the comment has been replaced or removed.

Trait Implementations§

source§

impl Debug for Comment<'_>

source§

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

Formats the value using the given formatter. Read more
source§

impl UserData for Comment<'_>

source§

fn user_data(&self) -> &dyn Any

Returns a reference to the attached user data.
source§

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

Returns a mutable reference to the attached user data.
source§

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

Attaches user data to a rewritable unit.

Auto Trait Implementations§

§

impl<'i> !RefUnwindSafe for Comment<'i>

§

impl<'i> !Send for Comment<'i>

§

impl<'i> !Sync for Comment<'i>

§

impl<'i> Unpin for Comment<'i>

§

impl<'i> !UnwindSafe for Comment<'i>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.