Struct RenderOpts 

pub struct RenderOpts {
    pub cols: u16,
    pub rows: u16,
    pub color_level: u8,
    pub include_plain_output: Option<bool>,
}

Per-render geometry (render_frame’s opts arg). cols is the terminal width handed to the core layout; rows is the viewport height fed to write_frame’s fullscreen/clear decisions.

Fields

cols: u16

rows: u16

color_level: u8

Detected terminal color level (chalk’s chalk.level, 0–3). The JS drop-in reads the GLOBAL chalk.level — exactly what ink uses and what the conformance harness forces to 3 — and threads it here. Core colorize emits SGR at this level for the core-colorize call sites (borders; Box backgroundColor fill). <Text> color is colorized JS-side by chalk (already level-aware) and arrives pre-styled. 0 → no SGR (non-color terminal); 1/2 → downgraded codes; 3 → truecolor (the prior behavior).

include_plain_output: Option<bool>

Whether to include plain_output in the FrameResult. When explicitly false, the result’s plain_output is an empty string — the render_styled computation still runs (its output is the transport input), but the string is not marshaled back across the FFI boundary. None (absent from JS) or true returns the full string, preserving backward compatibility for callers that do not set it (e.g. the test harness).

Trait Implementations

impl FromNapiValue for RenderOpts

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

This function called to convert napi values to native rust values

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

impl ToNapiValue for RenderOpts

unsafe fn to_napi_value(env: napi_env, val: RenderOpts) -> 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 RenderOpts

fn type_name() -> &'static str

fn value_type() -> ValueType

impl ValidateNapiValue for RenderOpts

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.