sysuri 0.4.0

A cross-platform crate for registering custom URIs with the OS
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

use std::path::PathBuf;

/// Represents a custom URI scheme registration
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct UriScheme {
    /// The scheme name (e.g., "myapp" for "myapp://")
    pub scheme: String,

    /// Human-readable description of the URI scheme
    pub description: String,

    /// Path to the executable that handles this URI scheme
    pub executable: PathBuf,

    /// Optional icon path for the URI scheme
    pub icon: Option<PathBuf>,
}

impl UriScheme {
    /// Create a new URI scheme registration
    ///
    /// # Arguments
    ///
    /// * `scheme` - The URI scheme name (without "://" suffix)
    /// * `description` - Human-readable description
    /// * `executable` - Path to the executable that handles URIs
    ///
    /// # Example
    ///
    /// ```no_run
    /// use sysuri::UriScheme;
    /// use std::path::PathBuf;
    ///
    /// let scheme = UriScheme::new(
    ///     "myapp",
    ///     "My Application Protocol",
    ///     PathBuf::from("/path/to/myapp")
    /// );
    /// ```
    pub fn new<S: Into<String>>(scheme: S, description: S, executable: PathBuf) -> Self {
        Self {
            scheme: scheme.into(),
            description: description.into(),
            executable,
            icon: None,
        }
    }

    /// Set an optional icon for the URI scheme
    ///
    /// # Arguments
    ///
    /// * `icon` - Path to the icon file
    pub fn with_icon(mut self, icon: PathBuf) -> Self {
        self.icon = Some(icon);
        self
    }

    /// Validate the URI scheme name
    ///
    /// Returns `true` if the scheme is valid according to RFC 3986
    pub fn is_valid_scheme(&self) -> bool {
        if self.scheme.is_empty() {
            return false;
        }

        // First character must be alphabetic
        let mut chars = self.scheme.chars();
        if let Some(first) = chars.next() {
            if !first.is_ascii_alphabetic() {
                return false;
            }
        }

        // Subsequent characters must be alphanumeric, +, -, or .
        chars.all(|c| c.is_ascii_alphanumeric() || c == '+' || c == '-' || c == '.')
    }

    /// Get the full URI format (e.g., "myapp://")
    pub fn full_uri(&self) -> String {
        format!("{}://", self.scheme)
    }
}

/// Handler for incoming URI requests
///
/// Implement this trait to handle URIs that are opened by the OS
pub trait UriHandler: Send + Sync {
    /// Called when a URI matching the registered scheme is opened
    ///
    /// # Arguments
    ///
    /// * `uri` - The full URI that was opened (e.g., "myapp://action/data")
    fn handle_uri(&self, uri: &str);
}

/// A simple function-based URI handler
pub struct FnHandler<F>
where
    F: Fn(&str) + Send + Sync,
{
    handler: F,
}

impl<F> FnHandler<F>
where
    F: Fn(&str) + Send + Sync,
{
    /// Create a new function-based handler
    pub fn new(handler: F) -> Self {
        Self { handler }
    }
}

impl<F> UriHandler for FnHandler<F>
where
    F: Fn(&str) + Send + Sync,
{
    fn handle_uri(&self, uri: &str) {
        (self.handler)(uri)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_valid_schemes() {
        let scheme = UriScheme::new("myapp", "Test", PathBuf::from("/test"));
        assert!(scheme.is_valid_scheme());

        let scheme = UriScheme::new("my-app", "Test", PathBuf::from("/test"));
        assert!(scheme.is_valid_scheme());

        let scheme = UriScheme::new("my+app", "Test", PathBuf::from("/test"));
        assert!(scheme.is_valid_scheme());

        let scheme = UriScheme::new("my.app", "Test", PathBuf::from("/test"));
        assert!(scheme.is_valid_scheme());
    }

    #[test]
    fn test_invalid_schemes() {
        let scheme = UriScheme::new("", "Test", PathBuf::from("/test"));
        assert!(!scheme.is_valid_scheme());

        let scheme = UriScheme::new("1myapp", "Test", PathBuf::from("/test"));
        assert!(!scheme.is_valid_scheme());

        let scheme = UriScheme::new("my_app", "Test", PathBuf::from("/test"));
        assert!(!scheme.is_valid_scheme());

        let scheme = UriScheme::new("my app", "Test", PathBuf::from("/test"));
        assert!(!scheme.is_valid_scheme());
    }

    #[test]
    fn test_full_uri() {
        let scheme = UriScheme::new("myapp", "Test", PathBuf::from("/test"));
        assert_eq!(scheme.full_uri(), "myapp://");
    }
}