Struct Hyperlink 

pub struct Hyperlink { /* private fields */ }

A terminal hyperlink attached to one run of text.

The URI and parameters remain logical data. The selected terminal output boundary escapes and frames them when it encodes OSC 8. Parameter names and values remain intentionally open-ended; terminals currently define id, while future terminals may add more keys.

use urushi::{Hyperlink, TextStyle};

let plain = TextStyle::new().hyperlink("https://example.com");
let identified = TextStyle::new().hyperlink(
    Hyperlink::new("https://example.com").parameter("id", "documentation"),
);

assert_eq!(plain.get_hyperlink().unwrap().uri(), "https://example.com");
assert_eq!(identified.get_hyperlink().unwrap().parameters().len(), 1);

Implementations

impl Hyperlink

pub fn new(uri: impl AsRef<str>) -> Self

Creates a hyperlink to uri without parameters.

pub fn parameter(self, name: impl AsRef<str>, value: impl AsRef<str>) -> Self

Adds one OSC 8 parameter.

pub fn uri(&self) -> &str

Returns the logical URI supplied by the caller.

pub fn parameters(&self) -> &[(String, String)]

Returns the logical parameters in insertion order.

Trait Implementations

impl Clone for Hyperlink

fn clone(&self) -> Hyperlink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hyperlink

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

Formats the value using the given formatter.

impl From<&str> for Hyperlink

fn from(uri: &str) -> Self

Converts to this type from the input type.

impl From<String> for Hyperlink

fn from(uri: String) -> Self

Converts to this type from the input type.

impl PartialEq for Hyperlink

fn eq(&self, other: &Hyperlink) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Hyperlink

impl StructuralPartialEq for Hyperlink