JsHandle

Struct JsHandle 

Source
pub struct JsHandle {
    inner: Weak<JsHandle>,
}
Expand description

JsHandle represents an in-page JavaScript object. JsHandles can be created with the [method: Page.evaluateHandle] method.

const windowHandle = await page.evaluateHandle(() => window);

JsHandle prevents the referenced JavaScript object being garbage collected unless the handle is exposed with [method: JsHandle.dispose]. JsHandles are auto-disposed when their origin frame gets navigated or the parent context gets destroyed.

JsHandle instances can be used as an argument in [method: Page.evalOnSelector], [method: Page.evaluate] and [method: Page.evaluateHandle] methods.

Fields§

§inner: Weak<JsHandle>

Implementations§

Source§

impl JsHandle

Source

pub(crate) fn new(inner: Weak<Impl>) -> Self

Source

pub(crate) fn guid(&self) -> Result<Str<Guid>, Error>

Source

pub async fn get_property(&mut self, name: &str) -> Result<JsHandle, Arc<Error>>

Fetches a single property from the referenced object.

Source

pub async fn get_properties( &mut self, ) -> Result<HashMap<String, JsHandle>, Arc<Error>>

The method returns a map with own property names as keys and JsHandle instances for the property values.

const handle = await page.evaluateHandle(() => ({window, document}));
const properties = await handle.getProperties();
const windowHandle = properties.get('window');
const documentHandle = properties.get('document');
await handle.dispose();
Source

pub async fn dispose(&mut self) -> Result<(), Arc<Error>>

Source

pub async fn json_value<U>(&mut self) -> Result<U, Arc<Error>>

Returns a JSON representation of the object. If the object has a toJSON function, it will not be called.

NOTE: The method will return an empty JSON object if the referenced object is not stringifiable. It will throw an error if the object has circular references.

Trait Implementations§

Source§

impl Display for JsHandle

Source§

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

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

impl PartialEq for JsHandle

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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 Serialize for JsHandle

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.