Struct VisualReferenceOutput 

#[non_exhaustive]
pub struct VisualReferenceOutput {
    pub base_screenshots: Option<Vec<BaseScreenshot>>,
    pub base_canary_run_id: Option<String>,
    pub browser_type: Option<BrowserType>,
}

If this canary performs visual monitoring by comparing screenshots, this structure contains the ID of the canary run that is used as the baseline for screenshots, and the coordinates of any parts of those screenshots that are ignored during visual monitoring comparison.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later.

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.

base_screenshots: Option<Vec<BaseScreenshot>>

An array of screenshots that are used as the baseline for comparisons during visual monitoring.

base_canary_run_id: Option<String>

The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.

browser_type: Option<BrowserType>

The browser type associated with this visual reference.

Implementations

impl VisualReferenceOutput

pub fn base_screenshots(&self) -> &[BaseScreenshot]

An array of screenshots that are used as the baseline for comparisons during visual monitoring.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .base_screenshots.is_none().

pub fn base_canary_run_id(&self) -> Option<&str>

The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.

pub fn browser_type(&self) -> Option<&BrowserType>

The browser type associated with this visual reference.

impl VisualReferenceOutput

pub fn builder() -> VisualReferenceOutputBuilder

Creates a new builder-style object to manufacture VisualReferenceOutput.

Trait Implementations

impl Clone for VisualReferenceOutput

fn clone(&self) -> VisualReferenceOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VisualReferenceOutput

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

Formats the value using the given formatter.

impl PartialEq for VisualReferenceOutput

fn eq(&self, other: &VisualReferenceOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VisualReferenceOutput