Struct xterm_js_sys::xterm::ViewportRangePosition

pub struct ViewportRangePosition {
    pub x: u16,
    pub y: u16,
}

An object representing a cell position within the viewport of the terminal.

(This is really an interface but because it's only ever produced by the user we just go and define our own type that satisfies the interface).

Fields

x: u16

The x position of the cell.

This is a 0-based index that refers to the space in between columns, not the column itself. Index 0 refers to the left side of the viewport, index Terminal::cols refers to the right side of the viewport. This can be thought of as how a cursor is positioned in a text editor.

y: u16

The y position of the cell.

This is a 0-based index that refers to a specific row.

Implementations

impl ViewportRangePosition

#[must_use]pub const fn new(x: u16, y: u16) -> Self

Constructor.

Trait Implementations

impl Clone for ViewportRangePosition

fn clone(&self) -> ViewportRangePosition

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ViewportRangePosition

impl Debug for ViewportRangePosition

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

Formats the value using the given formatter.

impl Eq for ViewportRangePosition

impl From<ViewportRangePosition> for JsValue

fn from(value: ViewportRangePosition) -> Self

Performs the conversion.

impl FromWasmAbi for ViewportRangePosition

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 ViewportRangePosition

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 OptionFromWasmAbi for ViewportRangePosition

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 ViewportRangePosition

fn none() -> Self::Abi

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

impl PartialEq<ViewportRangePosition> for ViewportRangePosition

fn eq(&self, other: &ViewportRangePosition) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ViewportRangePosition) -> bool

This method tests for !=.

impl RefFromWasmAbi for ViewportRangePosition

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, ViewportRangePosition>

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 ViewportRangePosition

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, ViewportRangePosition>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl StructuralEq for ViewportRangePosition

impl StructuralPartialEq for ViewportRangePosition

impl WasmDescribe for ViewportRangePosition

fn describe()