Struct nipper::Document

pub struct Document {
    pub errors: Vec<Cow<'static, str>>,
    pub quirks_mode: QuirksMode,
    // some fields omitted
}

Document represents an HTML document to be manipulated.

Fields

errors: Vec<Cow<'static, str>>

Errors that occurred during parsing.

quirks_mode: QuirksMode

The document's quirks mode.

Implementations

impl Document

pub fn root(&self) -> NodeRef<NodeData>

Return the underlying root document node.

impl Document

pub fn html(&self) -> StrTendril

Gets the HTML contents of the document. It includes the text and comment nodes.

pub fn text(&self) -> StrTendril

Gets the text content of the document.

impl Document

pub fn select(&self, sel: &str) -> Selection

Gets the descendants of the root document node in the current, filter by a selector. It returns a new selection object containing these matched elements.

Panics

Panics if failed to parse the given CSS selector.

pub fn nip(&self, sel: &str) -> Selection

Alias for select, it gets the descendants of the root document node in the current, filter by a selector. It returns a new selection object containing these matched elements.

Panics

Panics if failed to parse the given CSS selector.

pub fn try_select(&self, sel: &str) -> Option<Selection>

Gets the descendants of the root document node in the current, filter by a selector. It returns a new selection object containing these matched elements.

pub fn select_matcher<'a, 'b>(&'a self, matcher: &'b Matcher) -> Selection<'a>

Gets the descendants of the root document node in the current, filter by a matcher. It returns a new selection object containing these matched elements.

Trait Implementations

impl Default for Document

fn default() -> Document

Returns the "default value" for a type.

impl<'_> From<&'_ String> for Document

fn from(html: &String) -> Document

Performs the conversion.

impl<'_> From<&'_ str> for Document

fn from(html: &str) -> Document

Performs the conversion.

impl From<Tendril<UTF8, NonAtomic>> for Document

fn from(html: StrTendril) -> Document

Performs the conversion.

impl TreeSink for Document

type Output = Self

The overall result of parsing.

fn finish(self) -> Self

Consume this sink and return the overall result of parsing.

type Handle = NodeId

Handle is a reference to a DOM node. The tree builder requires that a Handle implements Clone to get another reference to the same node.

fn parse_error(&mut self, msg: Cow<'static, str>)

Signal a parse error.

fn get_document(&mut self) -> NodeId

Get a handle to the Document node.

fn get_template_contents(&mut self, target: &NodeId) -> NodeId

Get a handle to a template's template contents. The tree builder promises this will never be called with something else than a template element.

fn set_quirks_mode(&mut self, mode: QuirksMode)

Set the document's quirks mode.

fn same_node(&self, x: &NodeId, y: &NodeId) -> bool

Do two handles refer to the same node?

fn elem_name(&self, target: &NodeId) -> ExpandedName

What is the name of this element?

fn create_element(
    &mut self,
    name: QualName,
    attrs: Vec<Attribute>,
    flags: ElementFlags
) -> NodeId

Create an element.

fn create_comment(&mut self, text: StrTendril) -> NodeId

Create a comment node.

fn create_pi(&mut self, target: StrTendril, data: StrTendril) -> NodeId

Create a Processing Instruction node.

fn append(&mut self, parent: &NodeId, child: NodeOrText<NodeId>)

Append a node as the last child of the given node. If this would produce adjacent sibling text nodes, it should concatenate the text instead.

fn append_before_sibling(&mut self, sibling: &NodeId, child: NodeOrText<NodeId>)

Append a node as the sibling immediately before the given node.

fn append_based_on_parent_node(
    &mut self,
    element: &NodeId,
    prev_element: &NodeId,
    child: NodeOrText<NodeId>
)

When the insertion point is decided by the existence of a parent node of the element, we consider both possibilities and send the element which will be used if a parent node exists, along with the element to be used if there isn't one.

fn append_doctype_to_document(
    &mut self,
    name: StrTendril,
    public_id: StrTendril,
    system_id: StrTendril
)

Append a DOCTYPE element to the Document node.

fn add_attrs_if_missing(&mut self, target: &NodeId, attrs: Vec<Attribute>)

Add each attribute to the given element, if no attribute with that name already exists. The tree builder promises this will never be called with something else than an element.

fn remove_from_parent(&mut self, target: &NodeId)

Detach the given node from its parent.

fn reparent_children(&mut self, node: &NodeId, new_parent: &NodeId)

Remove all the children from node and append them to new_parent.

fn mark_script_already_started(&mut self, _node: &Self::Handle)

Mark a HTML <script> as "already started".

fn pop(&mut self, _node: &Self::Handle)

Indicate that a node was popped off the stack of open elements.

fn associate_with_form(
    &mut self,
    _target: &Self::Handle,
    _form: &Self::Handle,
    _nodes: (&Self::Handle, Option<&Self::Handle>)
)

Associate the given form-associatable element with the form element

fn is_mathml_annotation_xml_integration_point(
    &self,
    _handle: &Self::Handle
) -> bool

Returns true if the adjusted current node is an HTML integration point and the token is a start tag.

fn set_current_line(&mut self, _line_number: u64)

Called whenever the line number changes.

fn complete_script(&mut self, _node: &Self::Handle) -> NextParserState

Indicate that a script element is complete.