Struct xterm_js_sys::xterm::FunctionIdentifier

pub struct FunctionIdentifier {
    pub(super) prefix: Option<Str>,
    pub(super) intermediates: Option<Str>,
    pub(super) final_byte: Str,
}

Data type to register a CSI, DCS, or ESC callback in the parser in the form:

• ESC I..I F
• CSI Prefix P..P I..I F
• DCS Prefix P..P I..I F data_bytes ST

with these rules/restrictions:

• prefix can only be used with CSI and DCS
• only one leading prefix byte is recognized by the parser before any other parameter bytes (P..P)
• intermediate bytes are recognized up to 2

For custom sequences make sure to read ECMA-48 and the resources at vt100.net to not clash with existing sequences or reserved address space. General recommendations:

• use private address space (see ECMA-48)
• use max one intermediate byte (technically not limited by the spec, in practice there are no sequences with more than one intermediate byte, thus parsers might get confused with more intermediates)
• test against other common emulators to check whether they escape/ignore the sequence correctly

Notes:

• OSC command registration is handled differently (see addOscHandler).
• APC, PM or SOS is currently not supported.

(This is really an interface, but we just go and define our own type that satisfies the interface.)

Fields

prefix: Option<Str>

Optional prefix byte; must be in range \x3c .. \x3f. Usable in CSI and DCS.

intermediates: Option<Str>

Optional intermediate bytes; must be in range \x20 .. \x2f. Usable in CSI, DCS, and ESC.

final_byte: Str

Final byte; must be in range \x40 .. \x7e for CSI and DCS, \x30 .. \x7E for ESC.

Implementations

impl FunctionIdentifier

#[must_use]pub const fn new(
    prefix: Option<Str>,
    intermediates: Option<Str>,
    final_byte: Str
) -> Self

Constructor.

impl FunctionIdentifier

#[must_use]pub fn prefix(&self) -> Option<Str>

Optional prefix byte; must be in range \x3c .. \x3f. Usable in CSI and DCS. Getter.

pub fn set_prefix(&mut self, prefix: Option<Str>)

Optional prefix byte; must be in range \x3c .. \x3f. Usable in CSI and DCS. Setter.

#[must_use]pub fn intermediates(&self) -> Option<Str>

Optional intermediate bytes; must be in range \x20 .. \x2f. Usable in CSI, DCS, and ESC. Getter.

pub fn set_intermediates(&mut self, intermediates: Option<Str>)

Optional intermediate bytes; must be in range \x20 .. \x2f. Usable in CSI, DCS, and ESC. Setter.

#[must_use]pub fn final_byte(&self) -> Str

Final byte; must be in range \x40 .. \x7e for CSI and DCS, \x30 .. \x7E for ESC. Getter.

pub fn set_final_byte(&mut self, final_byte: Str)

Final byte; must be in range \x40 .. \x7e for CSI and DCS, \x30 .. \x7E for ESC. Setter.

Trait Implementations

impl Clone for FunctionIdentifier

fn clone(&self) -> FunctionIdentifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionIdentifier

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

Formats the value using the given formatter.

impl From<FunctionIdentifier> for JsValue

fn from(value: FunctionIdentifier) -> Self

Performs the conversion.

impl FromWasmAbi for FunctionIdentifier

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 FunctionIdentifier

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 FunctionIdentifier

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 FunctionIdentifier

fn none() -> Self::Abi

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

impl RefFromWasmAbi for FunctionIdentifier

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, FunctionIdentifier>

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 FunctionIdentifier

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, FunctionIdentifier>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for FunctionIdentifier

fn describe()