Trait xterm_js_sys::ext::disposable::XtermDisposable

[+] Show declaration

pub trait XtermDisposable {
    fn dispose(&self);

    fn into_js_by_ref(&self) -> Disposable
    where
        Self: Clone + 'static,
    { ... }
    fn into_js(self) -> Disposable
    where
        Self: Sized + 'static,
    { ... }
    fn into_js_inner(&'static self) -> Object
    where
        Self: 'static,
    { ... }
}

This is supported on feature="ext" only.

[−] Expand description

Rust version of the Disposable interface.

See the "mirroring interfaces" section of the xterm module docs for more information.

Required methods

fn dispose(&self)[−]

This is supported on feature="ext" only.

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.

Dual of Disposable::dispose.

Provided methods

fn into_js_by_ref(&self) -> Disposable where
    Self: Clone + 'static, [−]

This is supported on feature="ext" only.

Copy of IntoJsInterface::by_ref.

fn into_js(self) -> Disposable where
    Self: Sized + 'static, [−]

This is supported on feature="ext" only.

Copy of IntoJsInterface::to.

fn into_js_inner(&'static self) -> Object where
    Self: 'static, [−]

This is supported on feature="ext" only.

Internal version of into_js_by_ref that doesn't leak self.

Useful for trait/interface hierarchies.

Implementors

impl<X> XtermDisposable for X where
    X: Clone + 'static,
    X: AsRef<Disposable>, [+]

This provides an impl of the XtermDisposable Rust trait for all things that 'implement' the Disposable JS interface the wasm-bindgen way.

See the "mirroring interfaces" section of the xterm module docs for more information.

fn dispose(&self)[−]

This is supported on feature="ext" only.

dispose for types that implement the Disposable interface.

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

This is supported on feature="ext" only.

into_js_by_ref for types that implement the Disposable interface.

This differs from the default impl in that it manages to avoid a Clone before effectively doing what into_js does.

fn into_js(self) -> Disposable[−]

This is supported on feature="ext" only.

into_js for types that implement the Disposable interface.

This differs from the default impl in that it manages to avoid "double wrapping" the methods in the interface (types that impl Disposable the wasm-bindgen way already have a wrapped up Object they can hand us).