Struct termwiz::hyperlink::Rule

pub struct Rule {
    pub regex: Regex,
    pub format: String,
}

In addition to handling explicit escape sequences to enable hyperlinks, we also support defining rules that match text from screen lines and generate implicit hyperlinks. This can be used both for making http URLs clickable and also to make other text clickable. For example, you might define a rule that makes bug or issue numbers expand to the corresponding URL to view the details for that issue. The Rule struct is configuration that is passed to the terminal and is evaluated when processing mouse hover events.

Fields

regex: Regex

The compiled regex for the rule. This is used to match against a line of text from the screen (typically the line over which the mouse is hovering).

format: String

The format string that defines how to transform the matched text into a URL. For example, a format string of $0 expands to the entire matched text, whereas mailto:$0 expands to the matched text with a mailto: prefix. More formally, each instance of $N (where N is a number) in the format string is replaced by the capture number N from the regex. The replacements are carried out in reverse order, starting with the highest numbered capture first. This avoids issues with ambiguous replacement of $11 vs $1 in the case of more complex regexes.

Implementations

impl Rule

pub fn new(regex: &str, format: &str) -> Result<Self>

Construct a new rule. It may fail if the regex is invalid.

pub fn match_hyperlinks(line: &str, rules: &[Rule]) -> Vec<RuleMatch>

Given a line of text from the terminal screen, and a set of rules, return the set of RuleMatches.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl FromDynamic for Rule

fn from_dynamic(
    value: &Value,
    options: FromDynamicOptions
) -> Result<Self, Error>

impl PlaceDynamic for Rule

fn place_dynamic(&self, place: &mut Object)

Convert from Self to Value, by storing directly into the target Object.

impl Serialize for Rule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl ToDynamic for Rule

fn to_dynamic(&self) -> Value