Skip to main content

Page

bao::cdp_client::api

Struct Page 

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

Page 本地状态(核心类)。

持有:target_id、main_frame、frame tree、本地实例(mouse/keyboard/…)、 EventEmitter inner、默认 timeout、opener weak、context 弱引用、 Connection 引用(共享,所有 Page 共用同一 CDP 连接)。

@trace REQ-BAO-API-006 [class:Page]

Implementations§

Source§

impl Page

Source

pub fn new(target_id: impl Into<String>, context: Weak<BrowserContext>) -> Page

构造 Page(由 BrowserContext::new_page 调用)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn new_with_connection( target_id: impl Into<String>, context: Weak<BrowserContext>, connection: Option<Rc<RefCell<Connection>>>, ) -> Page

构造 Page 并绑定 Connection(共享引用)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn is_closed(&self) -> bool

是否已关闭(本地标记)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn set_closed(&self, v: bool)

标记关闭(本地状态)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn target_id(&self) -> &str

Target ID。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn is_service_worker(&self) -> bool

是否 service worker。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn set_is_service_worker(&self, v: bool)

设置 is_service_worker(targetCreated 时根据 type 填入)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn main_frame(&self) -> Rc<Frame>

主 Frame(Rc clone)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn frames(&self) -> Vec<Rc<Frame>>

所有 Frame 列表(克隆)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn frames_count(&self) -> usize

Frame 总数。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn frame_by_id(&self, id: &str) -> Option<Rc<Frame>>

按 ID 查找 frame。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn add_frame(&self, id: impl Into<String>, frame: Rc<Frame>)

添加 frame(frameAttached 事件触发)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn remove_frame(&self, id: &str)

移除 frame(frameDetached 事件触发)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn workers(&self) -> Vec<Worker>

Workers(克隆)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn workers_count(&self) -> usize

Worker 数量。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn add_worker(&self, w: Worker)

添加 worker(attachedToTarget 事件触发)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn viewport(&self) -> Option<Viewport>

Viewport(本地缓存)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn viewport_size(&self) -> Option<(u32, u32)>

Viewport size(Width, Height)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn set_viewport(&self, v: Viewport)

设置 viewport(本地缓存;setViewport 命令成功后调用)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn target_info(&self) -> TargetInfo

TargetInfo(本地缓存克隆)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn set_target_info(&self, info: TargetInfo)

设置 target info。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn target(&self) -> Ref<'_, TargetInfo>

引用 target info(避免 clone)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn mouse(&self) -> &Mouse

引用 mouse(本地实例)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn keyboard(&self) -> &Keyboard

引用 keyboard。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn touchscreen(&self) -> &Touchscreen

引用 touchscreen。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn coverage(&self) -> &Coverage

引用 coverage。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn tracing(&self) -> &Tracing

引用 tracing。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn accessibility(&self) -> &Accessibility

引用 accessibility。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn default_timeout(&self) -> Option<Duration>

默认 timeout(Page.$ 等命令使用)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn default_navigation_timeout(&self) -> Option<Duration>

默认 navigation timeout。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn set_default_timeout(&self, ms: u64)

设置默认 timeout。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn set_default_navigation_timeout(&self, ms: u64)

设置默认 navigation timeout。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn clear_default_timeout(&self)

清除默认 timeout。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn clear_default_navigation_timeout(&self)

清除默认 navigation timeout。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn opener(&self) -> Option<Rc<Page>>

Opener Page(weak,可能已 drop)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn set_opener(&self, opener: Weak<Page>)

设置 opener。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn browser_context(&self) -> Option<Rc<BrowserContext>>

所属 BrowserContext(weak upgrade)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn browser(&self) -> Option<Rc<Browser>>

所属 Browser(context → browser)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn url(&self) -> String

主 frame URL(本地缓存)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn set_url(&self, url: impl Into<String>)

设置主 frame URL(frameNavigated 事件触发)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn events_inner(&self) -> &Rc<EventEmitterInner>

引用 EventEmitter inner(测试用)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn has_connection(&self) -> bool

是否绑定 Connection(可发送 CDP 命令)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn set_connection(&self, conn: Rc<RefCell<Connection>>)

设置 Connection(共享引用)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn goto(&self, url: &str) -> Result<Value, CdpError>

导航到指定 URL(CDP Page.navigate)。

§错误
  • CdpError::ConnectionClosed: 未绑定 Connection 或连接已断开
  • CdpError::ProtocolError: 导航失败(无效 URL / 网络错误)

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn evaluate(&self, expression: &str) -> Result<Value, CdpError>

在页面上下文中执行 JavaScript 表达式(CDP Runtime.evaluate)。

§错误
  • CdpError::ConnectionClosed: 未绑定 Connection
  • CdpError::ProtocolError: JS 执行异常

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn screenshot(&self) -> Result<Value, CdpError>

截取页面截图(CDP Page.captureScreenshot)。

返回 base64 编码的截图数据。

§错误
  • CdpError::ConnectionClosed: 未绑定 Connection

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn screenshot_with_format(&self, format: &str) -> Result<Value, CdpError>

截取页面截图(指定格式)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn close(&self) -> Result<Value, CdpError>

关闭页面(CDP Page.close)。

同时标记本地 closed = true。

@trace REQ-BAO-API-006 [class:Page]

Source

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

获取页面标题(CDP Runtime.evaluate 执行 document.title)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn set_viewport_cdp(&self, viewport: Viewport) -> Result<Value, CdpError>

设置页面 Viewport(CDP Emulation.setDeviceMetricsOverride)。

同时更新本地 viewport 缓存。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn send_cdp_command( &self, method: &str, params: Value, ) -> Result<Value, CdpError>

发送任意 CDP 命令(底层)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn send_cdp_command_with_session( &self, method: &str, params: Value, session_id: &str, ) -> Result<Value, CdpError>

发送 CDP 命令(带 session_id)。

@trace REQ-BAO-API-006 [class:Page]

Source

pub fn recv_cdp_event(&self) -> Result<Option<CdpEvent>, CdpError>

接收一个 CDP 事件。

@trace REQ-BAO-API-006 [class:Page]

Trait Implementations§

Source§

impl Debug for Page

Source§

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

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

impl EventEmitter for Page

Source§

fn on(&self, event: &str, handler: Arc<dyn Fn(&[Value])>) -> u64

注册持久 handler,返回 HandlerId(可用于 off)。
Source§

fn once(&self, event: &str, handler: Arc<dyn Fn(&[Value])>) -> u64

注册一次性 handler(emit 后自动移除)。
Source§

fn off(&self, event: &str, handler_id: u64) -> SubscriptionResult

按 ID 移除 handler。返回 NotFound 时表示 ID 不存在。
Source§

fn remove_all_listeners(&self, event: Option<&str>)

移除指定事件的所有 handler;event=None 时清空所有事件的所有 handler。
Source§

fn listener_count(&self, event: &str) -> usize

返回指定事件的 handler 数量。
Source§

fn emit(&self, event: &str, args: &[Value])

同步触发事件,按注册顺序调用所有 handler。 Read more

Auto Trait Implementations§

§

impl !Freeze for Page

§

impl !RefUnwindSafe for Page

§

impl !Send for Page

§

impl !Sync for Page

§

impl !UnwindSafe for Page

§

impl Unpin for Page

§

impl UnsafeUnpin for Page

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> AsCtxPtr for T
where T: ?Sized,

Source§

fn as_ctx_ptr(&self) -> *mut Self
where Self: Sized,

self’s address as *mut Self for deferred-task / scopeguard / ref_guard ctx slots. The closures/trampolines deref it as shared (&*p) — every method they reach is &self post-R-2, so no write provenance is required; the *mut spelling is purely to match the existing DerefOnDrop / HasAutoFlush / RefCount ABI.
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Filterable for T

Source§

fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. 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> MaybeBoxed<Box<T>> for T

Source§

fn maybe_boxed(self) -> Box<T>

Convert
Source§

impl<T> MaybeBoxed<T> for T

Source§

fn maybe_boxed(self) -> T

Convert
Source§

impl<T> MaybeSendSync for T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

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

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