Struct RenderSnapshot 

pub struct RenderSnapshot {
    pub schema_version: u32,
    pub width: usize,
    pub height: usize,
    pub plain: String,
    pub ansi: String,
    pub segments: Vec<SnapshotSegment>,
    pub rows: Option<Vec<Vec<SnapshotRun>>>,
    pub regions: Option<Vec<SnapshotRegion>>,
}

A render captured for comparison.

Schema 1 (RenderSnapshot::capture) stores the segments as rendered. Schema 2 (RenderSnapshot::capture_frame) stores rows of merged runs instead, drops control segments, and keeps ansi in the merged encoding; its segments is empty. Schema 3 (RenderSnapshot::capture_regions) is schema 2 plus the frame’s semantic regions. RenderSnapshot::diff compares a schema 2 or 3 snapshot with any schema by what shows, and compares regions when both snapshots have them. Every schema reads back.

Fields

schema_version: u32

width: usize

height: usize

plain: String

ansi: String

segments: Vec<SnapshotSegment>

rows: Option<Vec<Vec<SnapshotRun>>>

regions: Option<Vec<SnapshotRegion>>

Implementations

impl RenderSnapshot

pub fn capture_frame(target: &RenderTarget, renderable: &dyn Renderable) -> Self

A schema 2 snapshot, built from the render’s Frame.

pub fn capture_regions( target: &RenderTarget, renderable: &dyn Renderable, ) -> Self

A schema 3 snapshot: schema 2 plus the regions the renderables reported (see RenderTarget::frame_with_regions) and the links. Every field comes from one render, so the regions describe exactly the stored rows.

pub fn upgrade(&self) -> Self

This snapshot as schema 2: rows of merged runs from its segments. A schema 2 snapshot is returned unchanged. ansi is kept as captured.

pub fn capture(target: &RenderTarget, renderable: &dyn Renderable) -> Self

pub fn to_json(&self) -> Result<String, SnapshotError>

pub fn diff(&self, other: &Self) -> Option<String>

How other differs, or None when equal, without hiding style-only changes: a diff -u of the plain text when it differs, else the style-changed lines and the first differing segment field, else the first differing metadata path.

When either snapshot is schema 2 or 3, both are compared as schema 2: size, plain text and rows, not ansi or how the text was segmented; and regions too when both have them.

Trait Implementations

impl Clone for RenderSnapshot

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 RenderSnapshot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RenderSnapshot

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RenderSnapshot

impl PartialEq for RenderSnapshot

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RenderSnapshot

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RenderSnapshot