Skip to main content

ScreenshotOptions

Struct ScreenshotOptions 

Source
pub struct ScreenshotOptions {
    pub screenshot_type: Option<ScreenshotType>,
    pub quality: Option<u8>,
    pub full_page: Option<bool>,
    pub clip: Option<ScreenshotClip>,
    pub omit_background: Option<bool>,
    pub timeout: Option<f64>,
}
Expand description

Screenshot options

Configuration options for page and element screenshots.

Use the builder pattern to construct options:

§Example

use playwright_rs::protocol::{ScreenshotOptions, ScreenshotType, ScreenshotClip};

// JPEG with quality
let options = ScreenshotOptions::builder()
    .screenshot_type(ScreenshotType::Jpeg)
    .quality(80)
    .build();

// Full page screenshot
let options = ScreenshotOptions::builder()
    .full_page(true)
    .build();

// Clip region
let clip = ScreenshotClip {
    x: 10.0,
    y: 10.0,
    width: 200.0,
    height: 100.0,
};
let options = ScreenshotOptions::builder()
    .clip(clip)
    .build();

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

Fields§

§screenshot_type: Option<ScreenshotType>

Image format (png or jpeg)

§quality: Option<u8>

JPEG quality (0-100), only applies to jpeg format

§full_page: Option<bool>

Capture full scrollable page

§clip: Option<ScreenshotClip>

Clip region to capture

§omit_background: Option<bool>

Hide default white background (PNG only)

§timeout: Option<f64>

Screenshot timeout in milliseconds

Implementations§

Source§

impl ScreenshotOptions

Source

pub fn builder() -> ScreenshotOptionsBuilder

Create a new builder for ScreenshotOptions

Trait Implementations§

Source§

impl Clone for ScreenshotOptions

Source§

fn clone(&self) -> ScreenshotOptions

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 ScreenshotOptions

Source§

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

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

impl Default for ScreenshotOptions

Source§

fn default() -> ScreenshotOptions

Returns the “default value” for a 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> 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