Struct xterm_js_sys::xterm::Marker

#[repr(transparent)]pub struct Marker {
    obj: Disposable,
}

Represents a specific line in the terminal that is tracked when scrollback is trimmed and lines are added or removed. This is a single line that may be part of a larger wrapped line.

(This is a duck-typed interface).

Fields

obj: Disposable

Implementations

impl Marker

pub fn id(&self) -> u32

A unique identifier for this marker.

impl Marker

pub fn is_disposed(&self) -> bool

Whether this marker is disposed.

impl Marker

pub fn line(&self) -> i32

The actual line index in the buffer at this point in time. This is set to -1 if the marker has been disposed.

See get_line (if the ext feature is enabled) for a friendlier version of this function (returns an Option of an unsigned number).

impl Marker

#[must_use]pub fn get_line(&self) -> Option<u32>

This is supported on feature="ext" only.

The actual line index in the buffer at this point in time.

Like line, but returns an Option instead of -1.

Methods from Deref<Target = Disposable>

pub fn dispose(&self)

Disposes of the instance.

This can involve unregistering an event listener or cleaning up resources or anything else that should happen when an instance is disposed of.

Trait Implementations

impl AsRef<Disposable> for Marker

fn as_ref(&self) -> &Disposable

Performs the conversion.

impl AsRef<JsValue> for Marker

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Marker> for Marker

fn as_ref(&self) -> &Marker

Performs the conversion.

impl Clone for Marker

fn clone(&self) -> Marker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Marker

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

Formats the value using the given formatter.

impl Deref for Marker

type Target = Disposable

The resulting type after dereferencing.

fn deref(&self) -> &Disposable

Dereferences the value.

impl From<JsValue> for Marker

fn from(obj: JsValue) -> Marker

Performs the conversion.

impl From<Marker> for JsValue

fn from(obj: Marker) -> JsValue

Performs the conversion.

impl From<Marker> for Disposable

fn from(obj: Marker) -> Disposable

Performs the conversion.

impl FromWasmAbi for Marker

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 Marker

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 Marker

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 Marker

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 Marker

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 Marker

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 Marker

fn none() -> Self::Abi

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

impl RefFromWasmAbi for Marker

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Marker>

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 Marker

fn describe()