Skip to main content

Node

Struct Node 

Source
#[non_exhaustive]
pub struct Node { pub tag_name: Option<NodeType>, pub value: Option<String>, pub attributes: Option<Attributes>, pub explicitly_self_closing: bool, pub within_special_tag: Option<Vec<NodeType>>, pub children: Vec<Node>, }
Expand description

A node in the parsed HTML tree.

This struct is non-exhaustive. Construct nodes with Node::new, then call Node::with_explicit_self_closing when the source opening tag used />. A tag_name of None represents a synthetic container for zero or multiple top-level nodes.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§tag_name: Option<NodeType>

Element type, or None for a synthetic container.

§value: Option<String>

Text or comment content stored by this node.

§attributes: Option<Attributes>

Element attributes, when present.

§explicitly_self_closing: bool

Whether the source opening tag used explicit self-closing syntax (/>).

§within_special_tag: Option<Vec<NodeType>>

Parser-populated ancestor tags that affect list and blockquote formatting.

Manually constructed trees normally use None.

§children: Vec<Node>

Child nodes in source order.

Implementations§

Source§

impl Node

Source

pub fn is_in_special_tag(&self, tags: &[NodeType]) -> bool

Returns whether this node is inside any supplied formatting-sensitive tag.

Source

pub fn leading_spaces(&self) -> String

Returns indentation used when rendering nested list items.

Source

pub fn new( tag_name: Option<NodeType>, value: Option<String>, attributes: Option<Attributes>, within_special_tag: Option<Vec<NodeType>>, children: Vec<Node>, ) -> Self

Creates a node that was not explicitly self-closing.

Use tag_name: None for a synthetic container. value is used by text and comment nodes; manually constructed trees normally pass None for within_special_tag.

Source

pub fn with_explicit_self_closing(self) -> Self

Marks this node as using explicit self-closing syntax (/>).

HTML void semantics are derived independently from NodeType, so <img> closes immediately even when this flag is false.

Trait Implementations§

Source§

impl Clone for Node

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Node

Source§

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

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

impl Default for Node

Source§

fn default() -> Node

Returns the “default value” for a type. Read more
Source§

impl Drop for Node

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Eq for Node

Source§

impl PartialEq for Node

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl Freeze for Node

§

impl RefUnwindSafe for Node

§

impl Send for Node

§

impl Sync for Node

§

impl Unpin for Node

§

impl UnsafeUnpin for Node

§

impl UnwindSafe for Node

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