anstyle-hyperlink 1.0.2

ANSI escape code hyperlinks (OSC 8)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

/// Hyperlink formatter
///
/// # Example
///
/// ```
/// let link = anstyle_hyperlink::Hyperlink::with_url("https://docs.rs/anstyle/latest/anstyle/");
/// format!("Go to {link}anstyle's documentation{link:#}!");
/// ```
pub struct Hyperlink<D: core::fmt::Display> {
    url: Option<D>,
}

impl<D: core::fmt::Display> Hyperlink<D> {
    /// Directly create a hyperlink for a URL
    ///
    /// # Example
    ///
    /// ```
    /// let link = anstyle_hyperlink::Hyperlink::with_url("https://docs.rs/anstyle/latest/anstyle/");
    /// format!("Go to {link}anstyle's documentation{link:#}!");
    /// ```
    pub fn with_url(url: D) -> Self {
        Self { url: Some(url) }
    }
}

#[cfg(feature = "std")]
impl Hyperlink<String> {
    /// Create a hyperlink for a path
    ///
    /// # Example
    ///
    /// ```
    /// let path = std::env::current_dir().unwrap();
    /// let link = anstyle_hyperlink::Hyperlink::with_path(&path);
    /// format!("Go to {link}CWD{link:#}!");
    /// ```
    #[cfg(feature = "file")]
    pub fn with_path(path: &std::path::Path) -> Self {
        let url = crate::path_to_url(path);
        Self { url }
    }
}

impl<D: core::fmt::Display> Default for Hyperlink<D> {
    fn default() -> Self {
        Self { url: None }
    }
}

impl<D: core::fmt::Display> core::fmt::Display for Hyperlink<D> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        let Some(url) = self.url.as_ref() else {
            return Ok(());
        };
        if f.alternate() {
            write!(f, "\x1B]8;;\x1B\\")
        } else {
            write!(f, "\x1B]8;;{url}\x1B\\")
        }
    }
}