Channel

Struct Channel 

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

Channel provides RPC communication for a ChannelOwner.

Every ChannelOwner has a Channel that sends method calls to the Playwright server and receives responses.

§Architecture

In the JavaScript implementation, Channel is a Proxy object that intercepts method calls and forwards them to the connection.

In Python, Channel is a class with explicit method forwarding.

In Rust, we provide an explicit send method that handles:

  • Serialization of parameters
  • Sending to connection with object’s GUID
  • Waiting for response
  • Deserialization of result

§Example

// Example of using Channel to send RPC calls
use playwright_core::channel::Channel;
use serde::{Serialize, Deserialize};

#[derive(Serialize)]
struct LaunchParams {
    headless: bool,
}

#[derive(Deserialize)]
struct LaunchResult {
    browser: BrowserRef,
}

// Protocol response references use Arc<str> for performance
#[derive(Deserialize)]
struct BrowserRef {
    guid: String, // Simplified for example; actual implementation uses Arc<str>
}

async fn example(channel: &Channel) -> Result<(), Box<dyn std::error::Error>> {
    let params = LaunchParams { headless: true };
    let result: LaunchResult = channel.send("launch", params).await?;
    println!("Browser GUID: {}", result.browser.guid);
    Ok(())
}

Implementations§

Source§

impl Channel

Source

pub fn new(guid: Arc<str>, connection: Arc<dyn ConnectionLike>) -> Self

Creates a new Channel for the given object GUID.

§Arguments
  • guid - The GUID of the ChannelOwner this channel represents
  • connection - The connection to send messages through
Source

pub async fn send<P: Serialize, R: DeserializeOwned>( &self, method: &str, params: P, ) -> Result<R>

Sends a method call to the Playwright server and awaits the response.

This method:

  1. Serializes params to JSON
  2. Sends a JSON-RPC request to the server via the connection
  3. Waits for the response (correlated by request ID)
  4. Deserializes the response to type R
  5. Returns the result or an error
§Type Parameters
  • P - Parameter type (must be serializable)
  • R - Result type (must be deserializable)
§Arguments
  • method - The method name to call (e.g., “launch”, “goto”)
  • params - The parameters to send
§Example
#[derive(Serialize)]
struct GotoParams<'a> {
    url: &'a str,
}

#[derive(Deserialize)]
struct GotoResult {}

let params = GotoParams { url: "https://example.com" };
let _result: GotoResult = channel.send("goto", params).await?;
Source

pub async fn send_no_params<R: DeserializeOwned>( &self, method: &str, ) -> Result<R>

Sends a method call with no parameters.

Convenience method for calls that don’t need parameters.

Source

pub async fn send_no_result<P: Serialize>( &self, method: &str, params: P, ) -> Result<()>

Sends a method call that returns no result (void).

Convenience method for fire-and-forget calls.

Source

pub fn guid(&self) -> &str

Returns the GUID this channel represents.

Trait Implementations§

Source§

impl Clone for Channel

Source§

fn clone(&self) -> Channel

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
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