lnks 0.2.0

A library for reading and writing windows shortcuts (.lnk).
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
63
64
65
66
67
68
69
70
71
72
73
74
75

use std::{
    fmt, fs,
    path::{Path, PathBuf},
};

/// Icon resource used by a Windows shortcut.
#[derive(Debug, Clone, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Icon {
    /// Path to the file containing the icon resource.
    ///
    /// This is typically an executable (`.exe`), DLL, or `.ico` file.
    pub path: PathBuf,

    /// Index of the icon within the file.
    ///
    /// An index of `0` selects the first icon. Negative values may be used by
    /// some APIs to indicate a resource ID rather than a zero-based index.
    pub index: i32,
}

impl Icon {
    /// Create a new [`Icon`] using the first icon (`index = 0`) from the given path.
    #[must_use]
    pub fn new(path: PathBuf) -> Self {
        Self::with_index(path, 0)
    }

    /// Create a new [`Icon`] using an explicit icon index.
    #[must_use]
    pub fn with_index(path: PathBuf, index: i32) -> Self {
        Self { path, index }
    }
}

impl fmt::Display for Icon {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}@{}", self.path.display(), self.index)
    }
}

impl From<PathBuf> for Icon {
    fn from(path: PathBuf) -> Self {
        Self::new(path)
    }
}

impl From<Icon> for PathBuf {
    fn from(icon: Icon) -> PathBuf {
        icon.path
    }
}

impl AsRef<Path> for Icon {
    fn as_ref(&self) -> &Path {
        &self.path
    }
}

impl PartialEq for Icon {
    fn eq(&self, other: &Self) -> bool {
        if self.index != other.index {
            return false;
        }

        let a = &self.path;
        let b = &other.path;
        match (fs::canonicalize(a), fs::canonicalize(b)) {
            (Ok(a), Ok(b)) => a.as_os_str().eq_ignore_ascii_case(b.as_os_str()),
            _ => a.as_os_str().eq_ignore_ascii_case(b.as_os_str()),
        }
    }
}

impl Eq for Icon {}