everything-plugin 0.4.0

Rust binding for Everything's plugin SDK
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

# everything-plugin

[![crates.io](https://img.shields.io/crates/v/everything-plugin.svg)](https://crates.io/crates/everything-plugin)
[![Documentation](https://docs.rs/everything-plugin/badge.svg)](https://docs.rs/everything-plugin)
[![License](https://img.shields.io/crates/l/everything-plugin.svg)](../LICENSE.txt)

Rust binding for [Everything](https://www.voidtools.com/)'s [plugin SDK](https://www.voidtools.com/forum/viewtopic.php?t=16535).

Features:
- Load and save config with [Serde](https://github.com/serde-rs/serde)
- Make options pages GUI using [Winio](https://github.com/compio-rs/winio) in MVU (Elm) architecture
- Internationalization with [rust-i18n](https://github.com/longbridge/rust-i18n)
- Log with [tracing](https://github.com/tokio-rs/tracing)

Example:
```rust
mod options;

#[derive(Serialize, Deserialize, Debug, Default)]

pub struct Config {
    s: String,
}

pub struct App {
    config: Config,
}

impl PluginApp for App {
    type Config = Config;

    fn new(config: Option<Self::Config>) -> Self {
        Self {
            config: config.unwrap_or_default(),
        }
    }

    fn config(&self) -> &Self::Config {
        &self.config
    }

    fn into_config(self) -> Self::Config {
        self.config
    }
}

plugin_main!(App, {
    PluginHandler::builder()
        .name("Test Plugin")
        .description("A test plugin for Everything")
        .author("Chaoses-Ib")
        .version("0.1.0")
        .link("https://github.com/Chaoses-Ib/IbEverythingLib")
        .options_pages(vec![
            OptionsPage::builder()
                .name("Test Plugin")
                .load(ui::winio::spawn::<options::MainModel>)
                .build(),
        ])
        .build()
});
```

## Build

### Static CRT

`.cargo/config.toml`:
```toml
[target.'cfg(all(target_os = "windows", target_env = "msvc"))']
rustflags = ["-C", "target-feature=+crt-static"]
```
Increase build size by ~100 KiB.

## Debugging

- `.\Everything64.exe -debug`
  
  Unlike `-debug`, `-debug-log` doesn't work with stdout/stderr outputs.

## Plugins using this library

- [IbEverythingExt: Everything 拼音搜索、ローマ字検索、快速选择扩展](https://github.com/Chaoses-Ib/IbEverythingExt)