Struct xterm_js_sys::xterm::Buffer

[+] Show declaration

[+] Expand attributes
#[repr(transparent)]pub struct Buffer {
    obj: JsValue,
}

[−] Expand description

Represents a terminal buffer.

(This is a duck-typed interface).

Fields

obj: JsValue

Implementations

impl Buffer[−]

pub fn base_y(&self) -> u16[−]

Gets the line within the buffer where the top of the bottom page is (when fully scrolled down).

impl Buffer[−]

pub fn cursor_x(&self) -> u16[−]

Gets the x position of the cursor. This ranges between 0 (left side) and Terminal::cols() (after last cell of the row).

impl Buffer[−]

pub fn cursor_y(&self) -> u16[−]

Gets the y position of the cursor. This ranges between 0 (when the cursor is at Buffer::base_y()) and Terminal::rows() - 1 (when the cursor is on the last row).

impl Buffer[−]

pub fn length(&self) -> u32[−]

Gets the amount of lines in the buffer.

impl Buffer[−]

pub fn viewport_y(&self) -> u16[−]

Get the line within the buffer where the top of the viewport is.

impl Buffer[−]

pub fn get_line(&self, y: u32) -> Option<BufferLine>[−]

Gets a line from the buffer, or undefined if the line index does not exist.

Note that the result of this function should be used immediately after calling as when the terminal updates it could lead to unexpected behavior.

Takes y: the line index to get.

impl Buffer[−]

pub fn get_null_cell(&self) -> BufferCell[−]

Creates an empty cell object suitable as a cell reference in BufferLine::get_cell. Use this to avoid costly recreation of cell objects when dealing with tons of cells.

impl Buffer[−]

pub fn type(&self) -> BufferType[−]

Gets the type of the buffer.

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn as_f64(&self) -> Option<f64>[−]

This is supported on feature="ext" only.

Returns the f64 value of this JS value if it's an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool[−]

This is supported on feature="ext" only.

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>[−]

This is supported on feature="ext" only.

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it's not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>[−]

This is supported on feature="ext" only.

Returns the bool value of this JS value if it's an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool[−]

This is supported on feature="ext" only.

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool[−]

This is supported on feature="ext" only.

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool[−]

This is supported on feature="ext" only.

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool[−]

This is supported on feature="ext" only.

Tests whether typeof self == "object" && self !== null.

pub fn is_function(&self) -> bool[−]

This is supported on feature="ext" only.

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool[−]

This is supported on feature="ext" only.

Tests whether the value is "truthy".

pub fn is_falsy(&self) -> bool[−]

This is supported on feature="ext" only.

Tests whether the value is "falsy".

Trait Implementations

impl AsRef<Buffer> for Buffer[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &Buffer[−]

Performs the conversion.

impl AsRef<JsValue> for Buffer[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &JsValue[−]

Performs the conversion.

impl Clone for Buffer[+]

[+] Show hidden undocumented items

fn clone(&self) -> Buffer[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Buffer[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Deref for Buffer[+]

[+] Show hidden undocumented items

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue[−]

Dereferences the value.

impl From<Buffer> for JsValue[+]

[+] Show hidden undocumented items

fn from(obj: Buffer) -> JsValue[−]

Performs the conversion.

impl From<JsValue> for Buffer[+]

[+] Show hidden undocumented items

fn from(obj: JsValue) -> Buffer[−]

Performs the conversion.

impl FromWasmAbi for Buffer[+]

[+] Show hidden undocumented items

type Abi = <JsValue as FromWasmAbi>::Abi

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

unsafe fn from_abi(js: Self::Abi) -> Self[−]

Recover a Self from Self::Abi.

impl IntoWasmAbi for Buffer[+]

[+] Show hidden undocumented items

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> Self::Abi[−]

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

impl<'a> IntoWasmAbi for &'a Buffer[+]

[+] Show hidden undocumented items

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> Self::Abi[−]

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

impl JsCast for Buffer[+]

[+] Show hidden undocumented items

fn instanceof(val: &JsValue) -> bool[−]

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self[−]

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self[−]

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool where
    T: JsCast, [−]

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self> where
    T: JsCast, [−]

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast, [−]

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T where
    T: JsCast, [−]

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, [−]

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool where
    T: JsCast, [−]

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool[−]

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl OptionFromWasmAbi for Buffer[+]

[+] Show hidden undocumented items

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 Buffer[+]

[+] Show hidden undocumented items

fn none() -> Self::Abi[−]

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

impl<'a> OptionIntoWasmAbi for &'a Buffer[+]

[+] Show hidden undocumented items

fn none() -> Self::Abi[−]

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

impl RefFromWasmAbi for Buffer[+]

[+] Show hidden undocumented items

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Buffer>

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 WasmDescribe for Buffer[+]

[+] Show hidden undocumented items

fn describe()