Struct xterm_js_sys::xterm::TerminalAddon

[+] Show declaration

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

[−] Expand description

An addon that can provide additional functionality to the terminal.

(This is a duck-typed interface; its Rust dual is available here when the ext feature is enabled).

Fields

obj: Disposable

Implementations

impl TerminalAddon[−]

pub fn activate(&self, terminal: Terminal)[−]

This is called when the addon is activated.

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

[+] Show hidden undocumented items

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

Performs the conversion.

impl AsRef<JsValue> for TerminalAddon[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl AsRef<TerminalAddon> for TerminalAddon[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl Clone for TerminalAddon[+]

[+] Show hidden undocumented items

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalAddon[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Deref for TerminalAddon[+]

[+] Show hidden undocumented items

type Target = Disposable

The resulting type after dereferencing.

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

Dereferences the value.

impl From<JsValue> for TerminalAddon[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<TerminalAddon> for JsValue[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<TerminalAddon> for Disposable[+]

[+] Show hidden undocumented items

fn from(obj: TerminalAddon) -> Disposable[−]

Performs the conversion.

impl FromWasmAbi for TerminalAddon[+]

[+] 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<X> IntoJsInterface<TerminalAddon> for X where
    X: XtermAddon,
    X: Clone + 'static, [+]

Anything that implements XtermAddon (and is Clone + 'static) gets an implementation of IntoJsInterface<TerminalAddon>.

fn to(self) -> TerminalAddon[−]

This is supported on feature="ext" only.

Converts the XtermAddon implementor into an instance of TerminalAddon (the corresponding JS interface).

fn by_ref(&self) -> TerminalAddon[−]

This is supported on feature="ext" only.

Converts the XtermAddon implementor into an instance of TerminalAddon (the corresponding JS interface) by reference.

impl IntoWasmAbi for TerminalAddon[+]

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

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

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

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

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

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

[+] Show hidden undocumented items

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<TerminalAddon>

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

[+] Show hidden undocumented items

fn describe()