Struct stdweb::web::Document

pub struct Document(_);

The Document interface represents any web page loaded in the browser and serves as an entry point into the web page's content, which is the DOM tree.

(JavaScript docs)

Methods

impl Document

fn query_selector(&self, selector: &str) -> Option<Element>

Returns the first Element within the document that matches the specified selector, or group of selectors.

(JavaScript docs)

fn query_selector_all(&self, selector: &str) -> NodeList

Returns a list of the elements within the document (using depth-first pre-order traversal of the document's nodes) that match the specified group of selectors.

(JavaScript docs)

fn get_element_by_id(&self, id: &str) -> Option<Element>

Returns a reference to the element by its ID; the ID is a string which can be used to uniquely identify the element, found in the HTML id attribute.

(JavaScript docs)

fn create_element(&self, tag: &str) -> Element

In an HTML document, the Document.createElement() method creates the HTML element specified by tag, or an HTMLUnknownElement if tag isn't recognized. In other documents, it creates an element with a null namespace URI.

(JavaScript docs)

fn create_text_node(&self, text: &str) -> TextNode

Creates a new text node.

(JavaScript docs)

fn location(&self) -> Option<Location>

Returns a Location object which contains information about the URL of the document and provides methods for changing that URL and loading another URL.

(JavaScript docs)

Trait Implementations

impl IEventTarget for Document

fn add_event_listener<T, F>(&self, listener: F) -> EventListenerHandle where
    T: ConcreteEvent,
    F: FnMut(T) + 'static, 

Adds given event handler to the list the list of event listeners for the specified EventTarget on which it's called.

fn dispatch_event<T: IEvent>(&self, event: &T) -> bool

Dispatches an Event at this EventTarget, invoking the affected event listeners in the appropriate order. (JavaScript docs)

impl INode for Document

fn as_node(&self) -> &Node

Casts a reference to this object into a reference to a Node.

fn append_child<T: INode>(&self, child: &T)

Adds a node to the end of the list of children of a specified parent node.

fn remove_child<T: INode>(&self, child: &T) -> Result<(), NotFoundError>

Removes a child node from the DOM.

fn clone_node(&self, kind: CloneKind) -> Self

Returns a duplicate of the node on which this method was called.

fn contains<T: INode>(&self, node: &T) -> bool

Checks whenever a given node is a descendant of this one or not.

fn insert_before<T: INode, U: INode>(&self, new_node: &T, reference_node: &U)

Inserts the specified node before the reference node as a child of the current node.

fn replace_child<T: INode, U: INode>(&self, new_child: &T, old_child: &U)

Replaces one hild node of the specified node with another.

fn parent_node(&self) -> Option<Node>

Returns the parent of this node in the DOM tree.

fn first_child(&self) -> Option<Node>

Returns the node's first child in the tree, or None if the node is childless.

fn last_child(&self) -> Option<Node>

Returns the node's last child in the tree, or None if the node is childless.

fn next_sibling(&self) -> Option<Node>

Returns the node's next sibling in the tree, or None if there isn't such a node.

fn node_name(&self) -> String

Returns the name of the node.

fn node_type(&self) -> NodeType

Returns the type of the node.

fn node_value(&self) -> Option<String>

Returns the value of the node.

fn set_node_value(&self, value: Option<&str>)

Sets the value of the node.

fn owner_document(&self) -> Option<Document>

Returns the Document that this node belongs to.

fn parent_element(&self) -> Option<Element>

Returns an Element that is the parent of this node. Returns null if the node has no parent or the parent is not an Element.

fn previous_sibling(&self) -> Option<Node>

Returns the node's previous sibling in the tree, or None if there isn't such a node.

fn inner_text(&self) -> String

A property which represents the "rendered" text content of a node and its descendants. It approximates the text the user would get if they highlighted the contents of the element with the cursor and then copied to the clipboard.

fn text_content(&self) -> Option<String>

A property which represents the text content of a node and its descendants.

fn set_text_content(&self, text: &str)

Sets the text content of this node; calling thil removes all of node's children and replaces them with a single text node with the given value.

fn child_nodes(&self) -> NodeList

Returns a live collection of child nodes of this node.

fn base_uri(&self) -> Option<String>

Gets the base URL.

fn has_child_nodes(&self) -> bool

Returns whether this node has children nodes.

fn is_default_namespace(&self, namespace: &str) -> bool

Determines whether the given namespace is the default namespace of this node.

fn is_equal_node<T: INode>(&self, node: &T) -> bool

Tests whether this node is equal to another node. Two nodes are equal if they have the same type, defining characteristics, matching attributes, and so on.

fn is_same_node<T: INode>(&self, node: &T) -> bool

Test whether two Node references are the same.

fn lookup_prefix(&self, namespace: &str) -> Option<String>

Returns the prefix for the given namespace URI, if present.

fn lookup_namespace_uri(&self, prefix: &str) -> Option<String>

Returns the namespace URI for the given prefix.

fn normalize(&self)

Merges any adjacent text nodes and removes empty text nodes under this node.

impl Debug for Document

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

Formats the value using the given formatter.

impl Clone for Document

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsRef<Reference> for Document

fn as_ref(&self) -> &Reference

Performs the conversion.

impl<R: TryInto<Reference>> TryFrom<R> for Document where
    <R as TryInto<Reference>>::Error: Into<Box<Error>>, 

type Error = Box<Error>

The type returned in the event of a conversion error.

fn try_from(value: R) -> Result<Self, Self::Error>

Performs the conversion.