Struct BeamtermRenderer 

pub struct BeamtermRenderer { /* private fields */ }

JavaScript wrapper for the terminal renderer

Implementations

impl BeamtermRenderer

pub fn new(canvas_id: &str) -> Result<BeamtermRenderer, JsValue>

Create a new terminal renderer

pub fn enable_selection( &mut self, mode: SelectionMode, trim_whitespace: bool, ) -> Result<(), JsValue>

Enable default mouse selection behavior with built-in copy to clipboard

pub fn set_mouse_handler(&mut self, handler: Function) -> Result<(), JsValue>

Set a custom mouse event handler

pub fn get_text(&self, query: &CellQuery) -> String

Get selected text based on a cell query

pub fn copy_to_clipboard(&self, text: &str)

Copy text to the system clipboard

pub fn clear_selection(&self)

Clear any active selection

pub fn has_selection(&self) -> bool

Check if there is an active selection

pub fn new_render_batch(&mut self) -> Batch

Create a new render batch

pub fn terminal_size(&self) -> Size

Get the terminal dimensions in cells

pub fn cell_size(&self) -> Size

Get the cell size in pixels

pub fn render(&mut self)

Render the terminal to the canvas

pub fn resize(&mut self, width: i32, height: i32) -> Result<(), JsValue>

Resize the terminal to fit new canvas dimensions

Trait Implementations

impl Debug for BeamtermRenderer

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

Formats the value using the given formatter.

impl From<BeamtermRenderer> for JsValue

fn from(value: BeamtermRenderer) -> Self

Converts to this type from the input type.

impl FromWasmAbi for BeamtermRenderer

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for BeamtermRenderer

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for BeamtermRenderer

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<BeamtermRenderer>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for BeamtermRenderer

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for BeamtermRenderer

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for BeamtermRenderer

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<BeamtermRenderer>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for BeamtermRenderer

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<BeamtermRenderer>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for BeamtermRenderer

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for BeamtermRenderer

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[BeamtermRenderer]>

impl VectorIntoJsValue for BeamtermRenderer

fn vector_into_jsvalue(vector: Box<[BeamtermRenderer]>) -> JsValue

impl VectorIntoWasmAbi for BeamtermRenderer

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[BeamtermRenderer]>) -> Self::Abi

impl WasmDescribe for BeamtermRenderer

fn describe()

impl WasmDescribeVector for BeamtermRenderer

fn describe_vector()

impl SupportsConstructor for BeamtermRenderer

impl SupportsInstanceProperty for BeamtermRenderer

impl SupportsStaticProperty for BeamtermRenderer