Struct TracingStartOptions 

#[non_exhaustive]
pub struct TracingStartOptions {
    pub name: Option<String>,
    pub screenshots: Option<bool>,
    pub snapshots: Option<TraceSnapshots>,
    pub live: Option<bool>,
}

Options for starting a trace recording.

Serializes straight to the driver’s tracingStart parameters. The driver ignores keys it does not know rather than rejecting them, so a stale spelling costs every trace its snapshots and its timeline with no error anywhere; the unit tests below pin the current spellings.

See: https://playwright.dev/docs/api/class-tracing#tracing-start

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

Custom name for the trace. Shown in trace viewer as the trace title.

screenshots: Option<bool>

Whether to record a screencast during tracing. Its frames are the timeline preview in the trace viewer.

snapshots: Option<TraceSnapshots>

Which snapshots to capture on each action. snapshots(true) is the DOM snapshot alone; a TraceSnapshots value selects DOM, accessibility, and screen captures individually.

live: Option<bool>

Whether to enable live trace updates while recording. When true, the trace viewer can attach and observe the trace as it is being captured, rather than waiting for the recording to finish. Useful for debugging long-running flows.

See: https://playwright.dev/docs/api/class-tracing#tracing-start-option-live

Implementations

impl TracingStartOptions

pub fn name(self, name: impl Into<String>) -> Self

Trace name (affects file naming in the traces directory).

pub fn screenshots(self, screenshots: bool) -> Self

Capture screenshots during tracing.

pub fn snapshots(self, snapshots: impl Into<TraceSnapshots>) -> Self

Capture snapshots on each action: true for the DOM snapshot, or a TraceSnapshots selecting DOM, accessibility, and screen captures.

pub fn live(self, live: bool) -> Self

Enable live tracing (view in the trace viewer while running).

Trait Implementations

impl Clone for TracingStartOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TracingStartOptions

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

Formats the value using the given formatter.

impl Default for TracingStartOptions

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for TracingStartOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.