kinode_process_lib 1.0.1

A library for writing Kinode processes in Rust.
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

use crate::Request;

/// Add a new icon and/or widget to the Kinode homepage. Note that the process calling this
/// function must have the `homepage:homepage:sys` messaging [`crate::Capability`].
///
/// This should be called upon process startup to ensure that the process is added to the homepage.
///
/// An icon must be a base64 encoded SVG.
///
/// A path will be automatically placed underneath the namespace of the process. For example,
/// if the process is named `my:process:pkg`, and the path given is `/mypath`, the full path
/// will be `my:process:pkg/mypath`.
///
/// A widget should be HTML: it will be displayed in an iframe.
pub fn add_to_homepage(label: &str, icon: Option<&str>, path: Option<&str>, widget: Option<&str>) {
    Request::to(("our", "homepage", "homepage", "sys"))
        .body(
            serde_json::json!({
                "Add": {
                    "label": label,
                    "icon": icon,
                    "path": path,
                    "widget": widget
                }
            })
            .to_string(),
        )
        .send()
        .unwrap();
}

/// Remove the caller process from the Kinode homepage. Note that the process calling this function
/// must have the `homepage:homepage:sys` messaging [`crate::Capability`].
///
/// This usually isn't necessary as processes are not persisted on homepage between boots.
pub fn remove_from_homepage() {
    Request::to(("our", "homepage", "homepage", "sys"))
        .body("\"Remove\"")
        .send()
        .unwrap();
}