Struct xterm_js_sys::xterm::LinkMatcherOptions

pub struct LinkMatcherOptions {
    pub match_index: Option<u32>,
    pub validation_callback: &'static Closure<dyn FnMut(Str, Function)>,
    pub tooltip_callback: &'static Closure<dyn FnMut(MouseEvent, Str, ViewportRange) -> Option<bool>>,
    pub leave_callback: &'static Closure<dyn FnMut()>,
    pub priority: Option<i16>,
    pub will_link_activate: &'static Closure<dyn FnMut(MouseEvent, Str) -> bool>,
}

An object containing options for a link matcher.

Note: we had to make some significant compromises to mirroring this interface on the Rust side. Because the interface contains optional functions we choose to model this as a struct rather than as an extern-ed type: we can have fields that have a Closure or a function trait object in an Option but we have no way to have an optional function in a Rust trait.

Unfortunately Option<Closure<_>> and Option<dyn Fn{,Mut}(...)> don't implement OptionIntoWasmAbi, so we had to make the fields required. Additionally, the validation callback actually takes another callback which we couldn't model as the appropriate Rust type (dyn FnMut(bool)) because dyn FnMut and the Closure type don't implement FromWasmAbi (i.e. you can't produce something of those types on the JS side). So, we had to fall back to using js_sys::Function.

Fortunately since this interface is only ever produced by the user of the API, the first point (not having optional functions) isn't too big a deal. The second point makes actually making a LinkMatcherOptions instance in Rust kind of a pain, but it's still workable.

Since we can't actually do the Option<Closure<_>> thing, it might actually have been better to model this as an extern-ed type + a Rust trait, but let's leave that for another time. If there's interest in actually using this part of the API in Rust we can make the change (but I doubt there will be).

Fields

match_index: Option<u32>

The index of the link from the regex.match(text) call.

This defaults to 0 (for regular expressions without capture groups).

validation_callback: &'static Closure<dyn FnMut(Str, Function)>

A function that validates whether to create an individual link.

The callback that this function is given is passed a bool indicating whether the link given (uri) is valid.

Since the signature, post-translation, is rather cryptic, here's the original TypeScript binding:

validationCallback?: (
    uri: string,
    callback: (isValid: boolean) => void,
) => void;

tooltip_callback: &'static Closure<dyn FnMut(MouseEvent, Str, ViewportRange) -> Option<bool>>

A function that is called when the mouse hovers over a link for a period of time (defined by TerminalOptions::link_tooltip_hover_duration).

Since the signature, post-translation, is rather cryptic, here's the original TypeScript binding:

tooltipCallback?: (
    event: MouseEvent,
    uri: string,
    location: IViewportRange,
) => boolean | void;

leave_callback: &'static Closure<dyn FnMut()>

A function that is called when the mouse leaves a link.

Note that this can happen even when tooltip_callback hasn't fired for the link yet.

Just to be thorough, here's the original TypeScript binding:

leaveCallback?: () => void;

priority: Option<i16>

The priority of the link matcher.

This defined the order in which the link matcher is evaluated relative to others, from highest to lowest. The default value is 0.

will_link_activate: &'static Closure<dyn FnMut(MouseEvent, Str) -> bool>

A function that is called when the mousedown and click events occur.

This function is responsible for determining whether a link will be activated upon click. This enables only activating a link when a certain modifier is held down. If this function determines that an event does not activate the link (i.e. by returning false) then the event will continue propagation (e.g. double click to select word).

Since the signature, post-translation, is rather cryptic, here's the original TypeScript binding:

willLinkActivate?: (event: MouseEvent, uri: string) => boolean;

Trait Implementations

impl Clone for LinkMatcherOptions

fn clone(&self) -> LinkMatcherOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LinkMatcherOptions

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

Formats the value using the given formatter.

impl From<LinkMatcherOptions> for JsValue

fn from(value: LinkMatcherOptions) -> Self

Performs the conversion.

impl FromWasmAbi for LinkMatcherOptions

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 LinkMatcherOptions

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 LinkMatcherOptions

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 LinkMatcherOptions

fn none() -> Self::Abi

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

impl RefFromWasmAbi for LinkMatcherOptions

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, LinkMatcherOptions>

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 LinkMatcherOptions

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, LinkMatcherOptions>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for LinkMatcherOptions

fn describe()