Struct RenderOutput 

#[non_exhaustive]
pub struct RenderOutput {
    pub buffer_id: BufferId,
    pub spans: Vec<Vec<(usize, usize, StyleSpec)>>,
    pub signs: Vec<DiagSign>,
    pub key: (u64, usize, usize),
    pub perf: PerfBreakdown,
}

Per-frame output of the syntax pipeline.

Contains the styled span table (one inner Vec per document row) and the diagnostic signs for the gutter.

Examples

use hjkl_syntax::{RenderOutput, PerfBreakdown};
let out = RenderOutput::new(0, Vec::new(), Vec::new(), (0, 0, 0), PerfBreakdown::default());
assert_eq!(out.buffer_id, 0);

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.

buffer_id: BufferId

Routes spans/signs back to the matching buffer slot.

spans: Vec<Vec<(usize, usize, StyleSpec)>>

Per-row span table.

signs: Vec<DiagSign>

Diagnostic signs for the gutter.

key: (u64, usize, usize)

(dirty_gen, viewport_top, viewport_height) cache key.

perf: PerfBreakdown

Sub-step timing breakdown (zeroed in fully-sync path).

Implementations

impl RenderOutput

pub fn new( buffer_id: BufferId, spans: Vec<Vec<(usize, usize, StyleSpec)>>, signs: Vec<DiagSign>, key: (u64, usize, usize), perf: PerfBreakdown, ) -> Self

Construct a new RenderOutput.

Examples

use hjkl_syntax::{RenderOutput, PerfBreakdown};
let out = RenderOutput::new(1, Vec::new(), Vec::new(), (7, 0, 30), PerfBreakdown::new());
assert_eq!(out.buffer_id, 1);

Trait Implementations

impl Clone for RenderOutput

fn clone(&self) -> RenderOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderOutput

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

Formats the value using the given formatter.

impl PartialEq for RenderOutput

fn eq(&self, other: &Self) -> 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.