Struct FrameResult 

pub struct FrameResult {
    pub bytes: Buffer,
    pub output_height: u32,
    pub plain_output: String,
    pub static_output: String,
    pub render_time_ms: f64,
    pub changed_lines: u32,
}

The result of one render_frame. bytes is the exact transport payload the JS Ink class (the sole stream writer, M3-K1) writes verbatim; the rest are queryable side outputs.

Fields

bytes: Buffer

The diffed transport bytes from FrameWriter::write_frame. Empty only when the mode produced an empty write (handled as None by render_frame).

output_height: u32

The rendered frame height in rows (render_styled’s height output).

plain_output: String

The plain styled frame string (render_styled’s string output), before any transport framing. Mode-independent.

static_output: String

The <Static> subtree’s output for this frame — the text printed once above the live region (ink’s renderer.ts static branch, via render_static). "" when the tree has no static node (the common case); otherwise the static body plus a trailing newline.

render_time_ms: f64

Wall-clock milliseconds spent in the core render + transport write. NONDETERMINISTIC — excluded from every byte/equality assertion.

changed_lines: u32

How many visible lines this frame actually rewrote (FrameWriter::last_changed_lines). Pure ADDITIVE telemetry that rides alongside bytes and does not alter a single transport byte: 0 for a no-op timer-fire frame, the visible line count for a full repaint, the differ’s changed-line count for an incremental diff. Lets downstream pacing (P5.3) tell a real-change frame from a no-op fire. Note a fully no-op frame is returned as None by render_frame, so a delivered FrameResult normally carries changed_lines >= 1.

Trait Implementations

impl FromNapiValue for FrameResult

unsafe fn from_napi_value( env: napi_env, napi_val: napi_value, ) -> Result<FrameResult>

This function called to convert napi values to native rust values

fn from_unknown(value: Unknown<'_>) -> Result<Self, Error>

impl ToNapiValue for FrameResult

unsafe fn to_napi_value(env: napi_env, val: FrameResult) -> Result<napi_value>

This function called to convert rust values to napi values

fn into_unknown(self, env: &Env) -> Result<Unknown<'_>, Error>

impl TypeName for FrameResult

fn type_name() -> &'static str

fn value_type() -> ValueType

impl ValidateNapiValue for FrameResult

unsafe fn validate( env: *mut napi_env__, napi_val: *mut napi_value__, ) -> Result<*mut napi_value__, Error>

This function called to validate whether napi value passed to rust is valid type.