Enum HTML

Source
pub enum HTML {
    Empty,
    Tag(Rc<Tag>),
    Sequence(Rc<[HTML]>),
    Text(Rc<str>),
    Whitespace,
    RawNewline,
}
Expand description

Some HTML content, possibly empty. HTML content is classified as either “block”, “inline” or “empty”.

HTML values are normalised so sequences are not empty or a single item, and they do not contain nested sequences. Additionally, text is not empty, or a single space or newline character. This is necessary in order to ensure consistent matching of HTML sequences, and to test equality of HTML values.

Variants§

§

Empty

Represents the absence of any HTML content.

§

Tag(Rc<Tag>)

An HTML tag.

§

Sequence(Rc<[HTML]>)

A sequence of HTML content. The sequence is normalised so that it does not include Empty values, consecutive text nodes or nested sequences, and its length is at least 2.

§

Text(Rc<str>)

Raw text content. May contain special characters which will need to be escaped when rendering to HTML.

§

Whitespace

A single space. Sequences of whitespace are collapsed to this.

§

RawNewline

A literal newline. This is only useful in pre-formatted content, such as a <pre> tag; otherwise it is equivalent to whitespace.

Implementations§

Source§

impl HTML

Source

pub fn is_empty(&self) -> bool

Indicates whether this HTML item is HTML::Empty. Whitespace and literal newlines are not considered to be empty.

Source

pub fn is_block(&self) -> bool

Indicates whether this HTML item is block-level content, or otherwise does not need to be wrapped in a block-level element. Empty content is not considered to be block-level.

Source

pub fn is_inline(&self) -> bool

Indicates whether this HTML item is inline content which may need to be wrapped in a block-level element. Empty content is not considered to be inline, since it doesn’t need to be wrapped.

Source

pub fn is_whitespace(&self) -> bool

Indicates whether this HTML item is whitespace, including a literal newline or HTML::Empty.

Trait Implementations§

Source§

impl Clone for HTML

Source§

fn clone(&self) -> HTML

Returns a duplicate of the value. Read more
1.0.0 · Source§

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for HTML

Source§

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

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

impl From<&HTML> for Value

Source§

fn from(html: &HTML) -> Value

Converts to this type from the input type.
Source§

impl From<HTML> for Value

Source§

fn from(html: HTML) -> Value

Converts to this type from the input type.
Source§

impl<T: AsRef<str> + Into<Rc<str>>> From<T> for HTML

Source§

fn from(s: T) -> HTML

Converts to this type from the input type.
Source§

impl FromIterator<HTML> for HTML

Source§

fn from_iter<T: IntoIterator<Item = HTML>>(iter: T) -> HTML

Converts a sequence of HTML items into one normalised HTML item. Empty items are dropped, consecutive text nodes are merged, and nested sequences are flattened. The result is then wrapped in an HTML::Sequence only if there are at least two items.

Source§

impl PartialEq for HTML

Source§

fn eq(&self, other: &HTML) -> bool

Determines whether two HTML values are equal. Sequences and tags are compared deeply.

1.0.0 · Source§

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for HTML

Auto Trait Implementations§

§

impl Freeze for HTML

§

impl RefUnwindSafe for HTML

§

impl !Send for HTML

§

impl !Sync for HTML

§

impl Unpin for HTML

§

impl UnwindSafe for HTML

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

Source§

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,