Struct xterm_js_sys::xterm::Parser

#[repr(transparent)]pub struct Parser {
    obj: JsValue,
}

Allows hooking into the parser for custom handling of escape sequences.

(This is a duck-typed interface).

Fields

obj: JsValue

Implementations

impl Parser

fn register_csi_handler(
    &self,
    id: FunctionIdentifier,
    callback: &Closure<dyn FnMut(ReadOnlyArray<JsValue>) -> bool>
) -> Disposable

Adds a handler for CSI escape sequences.

Takes:

• id: Specifies the function identifier under which the callback gets registered; e.g. { final: 'm' } for SGR.
• callback: The function to handle the sequence. The callback is called with the numerical params. If the sequence has subparams the array will contain subarrays with their numerical values. Return true if the sequence was handled; false if we should try a previous handler (set by register_csi_handler). The most recently added handler is tried first.

Returns an Disposable you can call to remove this handler.

impl Parser

fn register_dcs_handler(
    &self,
    id: FunctionIdentifier,
    callback: &Closure<dyn FnMut(Str, ReadOnlyArray<JsValue>) -> bool>
) -> Disposable

Adds a handler for DCS escape sequences.

Takes:

• id: Specifies the function identifier under which the callback gets registered; e.g. { intermediates: '$', final: 'q' } for DECRQSS.
• callback: The function to handle the sequence. Note that the function will only be called once if the sequence finished successfully. There is currently no way to intercept smaller data chunks; data chunks will be stored up until the sequence is finished. Since DCS sequences are not limited by the amount of data this might impose a problem for big payloads. Currently xterm.js limits the DCS payload to 10 MB which should give enough room for most use cases. The function gets the payload and numerical parameters as arguments. Return true if the sequence was handled; false if we should try a previous handler (set by register_dcs_handler). The most recently added [handler is tried first.

Returns an Disposable you can call to remove this handler.

impl Parser

fn register_esc_handler(
    &self,
    id: FunctionIdentifier,
    handler: &Closure<dyn FnMut() -> bool>
) -> Disposable

Adds a handler for ESC escape sequences.

Takes:

• id: Specifies the function identifier under which the callback gets registered; e.g. { intermediates: '%', final: 'G' } for default charset selection.
• handler: The function to handle the sequence. Return true if the sequence was handled; false if we should try a previous handler (set by register_esc_handler). The most recently added handler is tried first.

Returns an Disposable you can call to remove this handler.

impl Parser

fn register_osc_handler(
    &self,
    ident: u32,
    callback: &Closure<dyn FnMut(Str) -> bool>
) -> Disposable

Adds a handler for OSC escape sequences.

Takes:

• ident: The number (first parameter) of the sequence.
• callback: The function to handle the sequence. Note that the function will only be called once if the sequence finished successfully. There is currently no way to intercept smaller data chunks; data chunks will be stored up until the sequence is finished. Since OSC sequences are not limited by the amount of data this might impose a problem for big payloads. Currently xterm.js limits OSC payloads to 10 MB which should give enough room for most use cases. The callback is called with OSC data string. Return true if the sequence was handled; false if we should try a previous handler (set by register_osc_handler). The most recently added handler is tried first.

Returns an Disposable you can call to remove this handler.

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<JsValue> for Parser

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Parser> for Parser

fn as_ref(&self) -> &Parser

Performs the conversion.

impl Clone for Parser

fn clone(&self) -> Parser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Parser

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

Formats the value using the given formatter.

impl Deref for Parser

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<JsValue> for Parser

fn from(obj: JsValue) -> Parser

Performs the conversion.

impl From<Parser> for JsValue

fn from(obj: Parser) -> JsValue

Performs the conversion.

impl FromWasmAbi for Parser

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 Parser

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 Parser

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 Parser

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 Parser

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 Parser

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 Parser

fn none() -> Self::Abi

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

impl RefFromWasmAbi for Parser

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Parser>

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 Parser

fn describe()