Struct xterm_js_sys::xterm::BufferCell

[+] Show declaration

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

[−] Expand description

Represents a single cell in the terminal’s buffer.

(This is a duck-typed interface).

Fields

obj: JsValue

Implementations

impl BufferCell[−]

pub fn get_bg_color(&self) -> Color[−]

Gets a cell’s background color number, this differs depending on what the color mode of the cell is:

• Default: This should be 0, representing the default background color (CSI 49 m).
• Palette: This is a number from 0 to 255 of ANSI colors (CSI 4(0-7) m, CSI 10(0-7) m, CSI 48 ; 5 ; 0-255 m).
• RGB: A hex value representing a ‘true color’: 0xRRGGBB (CSI 4 8 ; 2 ; Pi ; Pr ; Pg ; Pb)

impl BufferCell[−]

pub fn get_bg_color_mode(&self) -> u8[−]

Gets the number representation of the background color mode, this can be used to perform quick comparisons of 2 cells to see if they’re the same. Use is_bg_rgb, is_bg_palette, and is_bg_default to check what color mode a cell is.

impl BufferCell[−]

pub fn get_chars(&self) -> Str[−]

The character(s) within the cell. Examples of what this can contain:

• A normal width character
• A wide character (eg. CJK)
• An emoji

impl BufferCell[−]

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

Gets the UTF32 codepoint of single characters, if content is a combined string it returns the codepoint of the last character in the string.

impl BufferCell[−]

pub fn get_fg_color(&self) -> Color[−]

Gets a cell’s foreground color number, this differs depending on what the color mode of the cell is:

• Default: This should be 0, representing the default foreground color (CSI 39 m).
• Palette: This is a number from 0 to 255 of ANSI colors (CSI 3(0-7) m, CSI 9(0-7) m, CSI 38 ; 5 ; 0-255 m).
• RGB: A hex value representing a ‘true color’: 0xRRGGBB. (CSI 3 8 ; 2 ; Pi ; Pr ; Pg ; Pb)

impl BufferCell[−]

pub fn get_fg_color_mode(&self) -> u8[−]

Gets the number representation of the foreground color mode, this can be used to perform quick comparisons of 2 cells to see if they’re the same. Use is_fg_rgb, is_fg_palette, and is_fg_default to check what color mode a cell is.

impl BufferCell[−]

pub fn get_width(&self) -> u8[−]

The width of the character. Some examples:

• 1 for most cells.
• 2 for wide character like CJK glyphs.
• 0 for cells immediately following cells with a width of 2.

impl BufferCell[−]

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

Whether the cell has the default attribute (no color or style).

impl BufferCell[−]

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

Whether the cell is using the default background color mode.

impl BufferCell[−]

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

Whether the cell is using the palette background color mode.

impl BufferCell[−]

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

Whether the cell is using the RGB background color mode.

impl BufferCell[−]

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

Whether the cell has the inverse attribute (CSI 5 m).

impl BufferCell[−]

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

Whether the cell has the bold attribute (CSI 1 m).

impl BufferCell[−]

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

Whether the cell has the inverse attribute (CSI 2 m).

impl BufferCell[−]

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

Whether the cell is using the default foreground color mode.

impl BufferCell[−]

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

Whether the cell is using the palette foreground color mode.

impl BufferCell[−]

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

Whether the cell is using the RGB foreground color mode.

impl BufferCell[−]

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

Whether the cell has the inverse attribute (CSI 7 m).

impl BufferCell[−]

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

Whether the cell has the inverse attribute (CSI 8 m).

impl BufferCell[−]

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

Whether the cell has the inverse attribute (CSI 3 m).

impl BufferCell[−]

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

Whether the cell has the underline attribute (CSI 4 m).

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

[+] Show hidden undocumented items

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

Performs the conversion.

impl AsRef<JsValue> for BufferCell[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl Deref for BufferCell[+]

[+] Show hidden undocumented items

type Target = JsValue

The resulting type after dereferencing.

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

Dereferences the value.

impl From<BufferCell> for JsValue[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<JsValue> for BufferCell[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl FromWasmAbi for BufferCell[+]

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

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

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

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

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

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

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

[+] Show hidden undocumented items

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<BufferCell>

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

[+] Show hidden undocumented items

fn describe()