Struct Output

#[non_exhaustive]
pub struct Output {
    pub width: usize,
    pub height: usize,
    pub cells: Vec<Cell>,
    pub cursor: Cursor,
    pub title: String,
    pub mode: ScreenMode,
}

The parent type for all output

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.

width: usize

The shadow terminal’s width.

height: usize

The shadow terminal’s height.

cells: Vec<Cell>

A 1D array of all the cells in the shadow terminal’s screen.

cursor: Cursor

The shadow terminal’s cursor state.

title: String

The title of the terminal.

mode: ScreenMode

Whether the terminal is in the primary (scrolling) mode or the alternate mode.

Implementations

impl Output

pub fn convert_to_foreign( native: CompleteSurface, ) -> Result<Self, ShadowTerminalError>

Convert native output to a structure more suitable for non-Rust users.

Errors

If trying to convert the scrollback.

Trait Implementations

impl<'de> Deserialize<'de> for Output

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Output

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for Output

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

where __S: Serializer,

Serialize this value into the given Serde serializer.