Skip to main content

PageHandle

Struct PageHandle 

Source
pub struct PageHandle { /* private fields */ }
Expand description

A handle to an open browser tab.

On drop the underlying page is closed automatically.

§Example

use stygian_browser::{BrowserPool, BrowserConfig};
use stygian_browser::page::WaitUntil;
use std::time::Duration;

let pool = BrowserPool::new(BrowserConfig::default()).await?;
let handle = pool.acquire().await?;
let mut page = handle.browser().expect("valid browser").new_page().await?;
page.navigate("https://example.com", WaitUntil::DomContentLoaded, Duration::from_secs(30)).await?;
let html = page.content().await?;
drop(page); // closes the tab
handle.release().await;

Implementations§

Source§

impl PageHandle

Source

pub async fn navigate( &mut self, url: &str, condition: WaitUntil, nav_timeout: Duration, ) -> Result<()>

Navigate to url and wait for condition within nav_timeout.

§Errors

Returns BrowserError::NavigationFailed if the navigation times out or the CDP call fails.

Source

pub async fn wait_for_selector( &self, selector: &str, wait_timeout: Duration, ) -> Result<()>

Wait until document.querySelector(selector) is non-null (timeout).

§Errors

Returns BrowserError::NavigationFailed if the selector is not found within the given timeout.

Source

pub async fn set_resource_filter( &mut self, filter: ResourceFilter, ) -> Result<()>

Set a resource filter to block specific network request types.

Note: Requires Network.enable; called automatically.

§Errors

Returns a BrowserError::CdpError if the CDP call fails.

Source

pub async fn title(&self) -> Result<String>

Return the page’s <title> text.

§Errors

Returns BrowserError::ScriptExecutionFailed if the evaluation fails.

Source

pub async fn content(&self) -> Result<String>

Return the page’s full outer HTML.

§Errors

Returns BrowserError::ScriptExecutionFailed if the evaluation fails.

Source

pub async fn eval<T: DeserializeOwned>(&self, script: &str) -> Result<T>

Evaluate arbitrary JavaScript and return the result as T.

§Errors

Returns BrowserError::ScriptExecutionFailed on eval failure or deserialization error.

Source

pub async fn save_cookies(&self) -> Result<Vec<Cookie>>

Save all cookies for the current page’s origin.

§Errors

Returns BrowserError::CdpError if the CDP call fails.

Source

pub async fn screenshot(&self) -> Result<Vec<u8>>

Capture a screenshot of the current page as PNG bytes.

The screenshot is full-page by default (viewport clipped to the rendered layout area). Save the returned bytes to a .png file or process them in-memory.

§Errors

Returns BrowserError::CdpError if the CDP Page.captureScreenshot command fails, or BrowserError::Timeout if it exceeds cdp_timeout.

§Example
use stygian_browser::{BrowserPool, BrowserConfig, WaitUntil};
use std::{time::Duration, fs};

let pool = BrowserPool::new(BrowserConfig::default()).await?;
let handle = pool.acquire().await?;
let mut page = handle.browser().expect("valid browser").new_page().await?;
page.navigate("https://example.com", WaitUntil::Selector("body".to_string()), Duration::from_secs(30)).await?;
let png = page.screenshot().await?;
fs::write("screenshot.png", &png).unwrap();
Source

pub const fn inner(&self) -> &Page

Borrow the underlying chromiumoxide Page.

Source

pub async fn close(self) -> Result<()>

Close this page (tab).

Called automatically on drop; explicit call avoids suppressing the error.

Trait Implementations§

Source§

impl Drop for PageHandle

Source§

fn drop(&mut self)

Executes the destructor for this type. 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more