Struct TreeWalker

pub struct TreeWalker(/* private fields */);

Implementations

impl TreeWalker

pub fn previous_sibling(&self) -> JsNullable<Node>

pub fn previous_node(&self) -> JsNullable<Node>

pub fn parent_node(&self) -> JsNullable<Node>

pub fn next_sibling(&self) -> JsNullable<Node>

pub fn next_node(&self) -> JsNullable<Node>

pub fn last_child(&self) -> JsNullable<Node>

pub fn first_child(&self) -> JsNullable<Node>

pub fn new(browser: &Browser) -> TreeWalker

pub fn get_what_to_show(&self) -> JsNumber

pub fn set_what_to_show(&self, value: &dyn ToJs<JsNumber>)

pub fn get_root(&self) -> Node

pub fn set_root(&self, value: &Node)

pub fn get_filter(&self) -> JsNullable<JsValue>

pub fn set_filter(&self, value: &dyn ToJs<JsNullable<JsValue>>)

pub fn get_current_node(&self) -> Node

pub fn set_current_node(&self, value: &Node)

pub fn get_prototype(browser: &Browser) -> TreeWalker

pub fn set_prototype(browser: &Browser, value: &TreeWalker)

Methods from Deref<Target = JsObject>

pub fn js_get_field(&self, property: &dyn UseInJsCode) -> JsValue

Get a field value of in this object.

WSDOM provides built-in getters so you should use that instead when possible.

Use js_get_field only when needed

fn example(browser: Browser) {
    // you can get `window["location"]["href"]` like this
    let href: JsValue = wsdom::dom::location(&browser).js_get_field(&"href");

    // but you should use built-in getters instead
    let href: JsString = wsdom::dom::location(&browser).get_href();
}

pub fn js_set_field(&self, property: &dyn UseInJsCode, value: &dyn UseInJsCode)

Set a field value of in this object.

WSDOM provides built-in setters so you should use that instead when possible.

Use js_set_field only when needed

fn example(browser: Browser) {
    // you can set `window["location"]["href"]` like this
    wsdom::dom::location(&browser).js_set_field(&"href", &"https://example.com/");

    // but you should use built-in setters instead
    wsdom::dom::location(&browser).set_href(&"https://example.com");
}

pub fn js_call_method<'a>( &'a self, method_name: &'a str, args: impl IntoIterator<Item = &'a dyn UseInJsCode>, last_arg_variadic: bool, ) -> JsValue

Call a method on this object.

Most types in WSDOM already come with safe Rust wrappers for their methods, so you should use those instead.

fn example(browser: &Browser) {
    let console = wsdom::dom::console(browser);
    // you can call console.log like this
    console.js_call_method("log", [&"hello" as &_], false);
     
    // but the better way is to use
    wsdom::dom::console(&browser).log(&[&"Hello" as &_]);
}

Be aware that the first argument (method_name) is NOT escaped.

Set last_arg_variadic to true if you want to “spread” the last argument as obj.method(arg1, arg2, ...arg3).

pub fn js_call_self<'a>( &'a self, args: impl IntoIterator<Item = &'a dyn UseInJsCode>, last_arg_variadic: bool, ) -> JsValue

Call this object: obj().

Most types in WSDOM already come with safe Rust wrappers for their methods, so you should use those instead.

Methods from Deref<Target = JsValue>

pub fn browser(&self) -> &Browser

pub fn retrieve_json(&self) -> RetrieveFuture<'_, Value>

Retrive this value from the JS side to the Rust side. Returns Future whose output is a serde_json::Value.

use wsdom::dom::Browser

use wsdom::dom::HTMLInputElement;

async fn example(input: &HTMLInputElement) { let _val = input.get_value().retrieve_json().await; }

Trait Implementations

impl AsRef<JsObject> for TreeWalker

fn as_ref(&self) -> &JsObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<JsValue> for TreeWalker

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<TreeWalker> for TreeWalker

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TreeWalker

fn clone(&self) -> TreeWalker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for TreeWalker

type Target = JsObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Into<JsObject> for TreeWalker

fn into(self) -> JsObject

Converts this type into the (usually inferred) input type.

impl Into<JsValue> for TreeWalker

fn into(self) -> JsValue

Converts this type into the (usually inferred) input type.

impl JsCast for TreeWalker

fn unchecked_from_js(val: JsValue) -> Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

fn unchecked_into<T>(self) -> T

where T: JsCast,

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

impl RefCast for TreeWalker

type From = JsValue

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

impl UseInJsCode for TreeWalker

fn serialize_to(&self, buf: &mut Formatter<'_>) -> Result