Skip to main content

Dialog

Struct Dialog 

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

Dialog represents a browser dialog (alert, confirm, prompt, or beforeunload).

Dialogs are dispatched via the page.on(‘dialog’) event. Dialogs must be explicitly accepted or dismissed, otherwise the page will freeze waiting for the dialog to be handled.

See module-level documentation for usage examples.

See: https://playwright.dev/docs/api/class-dialog

Implementations§

Source§

impl Dialog

Source

pub fn new( parent: Arc<dyn ChannelOwner>, type_name: String, guid: Arc<str>, initializer: Value, ) -> Result<Self>

Creates a new Dialog from protocol initialization

This is called by the object factory when the server sends a __create__ message for a Dialog object.

Source

pub fn type_(&self) -> &str

Returns the dialog’s type.

Returns one of:

  • “alert” - Simple notification dialog
  • “confirm” - Yes/No confirmation dialog
  • “prompt” - Text input dialog
  • “beforeunload” - Page unload confirmation dialog

See: https://playwright.dev/docs/api/class-dialog#dialog-type

Source

pub fn message(&self) -> &str

Returns the message displayed in the dialog.

See: https://playwright.dev/docs/api/class-dialog#dialog-message

Source

pub fn default_value(&self) -> &str

Returns the default value for prompt dialogs.

For prompt dialogs, returns the default input value. For other dialog types (alert, confirm, beforeunload), returns an empty string.

See: https://playwright.dev/docs/api/class-dialog#dialog-default-value

Source

pub fn page(&self) -> Option<Page>

Returns the Page that owns this dialog.

The dialog’s parent in the protocol object hierarchy is the Page.

See: https://playwright.dev/docs/api/class-dialog#dialog-page

Source

pub async fn accept(&self, prompt_text: Option<&str>) -> Result<()>

Accepts the dialog.

For prompt dialogs, optionally provides text input. For other dialog types, the promptText parameter is ignored.

§Arguments
  • prompt_text - Optional text to enter in a prompt dialog
§Errors

Returns error if:

  • Dialog has already been accepted or dismissed
  • Communication with browser process fails

See: https://playwright.dev/docs/api/class-dialog#dialog-accept

Source

pub async fn dismiss(&self) -> Result<()>

Dismisses the dialog.

For confirm dialogs, this is equivalent to clicking “Cancel”. For prompt dialogs, this is equivalent to clicking “Cancel”.

§Errors

Returns error if:

  • Dialog has already been accepted or dismissed
  • Communication with browser process fails

See: https://playwright.dev/docs/api/class-dialog#dialog-dismiss

Trait Implementations§

Source§

impl Clone for Dialog

Source§

fn clone(&self) -> Dialog

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
Source§

impl Debug for Dialog

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !Freeze for Dialog

§

impl !RefUnwindSafe for Dialog

§

impl Send for Dialog

§

impl Sync for Dialog

§

impl Unpin for Dialog

§

impl UnsafeUnpin for Dialog

§

impl !UnwindSafe for Dialog

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

Source§

type Output = T

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