#tauri-plugin #scope #restore #save #assets #file

tauri-plugin-persisted-scope

Save filesystem and asset scopes and restore them when the app is reopened

20 releases

2.0.0-beta.7 May 1, 2024
2.0.0-beta.3 Mar 21, 2024
2.0.0-alpha.7 Dec 28, 2023
2.0.0-alpha.4 Oct 29, 2023
0.1.0 Jun 19, 2022

#152 in Filesystem

Download history 8/week @ 2024-02-14 117/week @ 2024-02-21 37/week @ 2024-02-28 99/week @ 2024-03-06 19/week @ 2024-03-13 104/week @ 2024-03-20 46/week @ 2024-03-27 215/week @ 2024-04-03 40/week @ 2024-04-10 140/week @ 2024-04-17 53/week @ 2024-04-24 99/week @ 2024-05-01

456 downloads per month

Apache-2.0 OR MIT

155KB
2K SLoC

Rust 1.5K SLoC // 0.0% comments TypeScript 548 SLoC // 0.5% comments JavaScript 2 SLoC // 0.5% comments

plugin-persisted-scope

Save filesystem and asset scopes and restore them when the app is reopened.

Install

This plugin requires a Rust version of at least 1.75

There are three general methods of installation that we can recommend.

  1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
  2. Pull sources directly from Github using git tags / revision hashes (most secure)
  3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

Install the Core plugin by adding the following to your Cargo.toml file:

src-tauri/Cargo.toml

[dependencies]
tauri-plugin-persisted-scope = "2.0.0-beta"
# alternatively with Git:
tauri-plugin-persisted-scope = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/main.rs

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_persisted_scope::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Afterwards the plugin will automatically save and restore filesystem and asset scopes.

Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

Partners

CrabNebula

For the complete list of sponsors please visit our website and Open Collective.

License

Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.

MIT or MIT/Apache 2.0 where applicable.

Dependencies

~17–60MB
~1M SLoC