tauri-plugin-redb-cache

English | 中文

English

A Tauri 2 plugin for HTTP and image caching using Redb with LRU memory cache and compression.

Platform Support

Compatibility

Features

• Two-tier caching: LRU memory cache + Redb persistent storage
• Automatic compression: Zlib compression for data >1KB
• Separate tables: HTTP responses and images stored separately
• Configurable: TTL, memory size, compression threshold
• Background cleanup: Automatic expired entry removal
• Offline-first: Perfect for field applications with unstable network

Installation

Rust

Add to your Cargo.toml:

[dependencies]
tauri-plugin-redb-cache = "0.1.2"

Or use a local path:

[dependencies]
tauri-plugin-redb-cache = { path = "../tauri-plugin-redb-cache" }

Permissions (Tauri 2 Required)

Add to your src-tauri/capabilities/default.json:

{
  "permissions": [
    "redb-cache:default"
  ]
}

JavaScript/TypeScript (Optional)

npm install @bishen/tauri-plugin-redb-cache-api
# or
pnpm add @bishen/tauri-plugin-redb-cache-api

Or call directly via invoke:

import { invoke } from '@tauri-apps/api/core';

const result = await invoke('plugin:redb-cache|cache_get', { key: 'mykey' });

Usage

Rust Setup

fn main() {
    tauri::Builder::default()
        .plugin(
            tauri_plugin_redb_cache::Builder::new()
                .http_ttl_ms(15 * 24 * 60 * 60 * 1000)  // 15 days
                .image_ttl_ms(7 * 24 * 60 * 60 * 1000)  // 7 days
                .memory_cache_size(100)
                .compress_threshold(1024)
                .build()
        )
        .run(tauri::generate_context!())
        .unwrap();
}

JavaScript/TypeScript

import { 
    cacheGet, cacheSet, getCacheInfo,
    imageCacheGet, imageCacheSet 
} from '@bishen/tauri-plugin-redb-cache-api';

// HTTP Cache
await cacheSet('api/users', new Uint8Array([...]));
const result = await cacheGet('api/users');
if (result) {
    const [data, timestamp] = result;
    console.log('Cached at:', new Date(timestamp));
}

// Image Cache
await imageCacheSet('avatar-123', 'data:image/png;base64,...');
const imageResult = await imageCacheGet('avatar-123');
if (imageResult) {
    const [dataUrl, timestamp] = imageResult;
    img.src = dataUrl;
}

// Get cache info
const info = await getCacheInfo();
console.log(`${info.count} entries, ${info.size_bytes} bytes`);

Configuration

API Reference

HTTP Cache

Image Cache

Architecture

┌─────────────────────────────────────────┐
│           JavaScript API                 │
└─────────────────────────────────────────┘
                    │
                    ▼
┌─────────────────────────────────────────┐
│         Tauri Commands (IPC)             │
└─────────────────────────────────────────┘
                    │
                    ▼
┌─────────────────────────────────────────┐
│   LRU Memory Cache (100 entries)         │
│   - Fast access for hot data             │
└─────────────────────────────────────────┘
                    │
                    ▼
┌─────────────────────────────────────────┐
│   Redb Persistent Storage                │
│   - Zlib compression (>1KB)              │
│   - http_cache table                     │
│   - image_cache table                    │
└─────────────────────────────────────────┘

中文

基于 Redb 的 Tauri 2 缓存插件，支持 LRU 内存缓存和数据压缩。

平台支持

版本兼容

特性

• 双层缓存架构：LRU 内存缓存 + Redb 持久化存储
• 自动压缩：大于 1KB 的数据自动 Zlib 压缩
• 独立存储表：HTTP 响应和图片分开存储
• 灵活配置：TTL、内存大小、压缩阈值均可配置
• 后台清理：自动清理过期缓存条目
• 离线优先：适合网络不稳定的外业调查场景

安装

Rust

在 Cargo.toml 中添加：

[dependencies]
tauri-plugin-redb-cache = "0.1.2"

或使用本地路径：

[dependencies]
tauri-plugin-redb-cache = { path = "../tauri-plugin-redb-cache" }

权限配置 (Tauri 2 必需)

在 src-tauri/capabilities/default.json 中添加：

{
  "permissions": [
    "redb-cache:default"
  ]
}

JavaScript/TypeScript (可选)

npm install @bishen/tauri-plugin-redb-cache-api
# 或
pnpm add @bishen/tauri-plugin-redb-cache-api

或直接通过 invoke 调用：

import { invoke } from '@tauri-apps/api/core';

const result = await invoke('plugin:redb-cache|cache_get', { key: 'mykey' });

使用方式

Rust 配置

fn main() {
    tauri::Builder::default()
        .plugin(
            tauri_plugin_redb_cache::Builder::new()
                .http_ttl_ms(15 * 24 * 60 * 60 * 1000)  // 15 天
                .image_ttl_ms(7 * 24 * 60 * 60 * 1000)  // 7 天
                .memory_cache_size(100)
                .compress_threshold(1024)
                .build()
        )
        .run(tauri::generate_context!())
        .unwrap();
}

JavaScript/TypeScript

import { 
    cacheGet, cacheSet, getCacheInfo,
    imageCacheGet, imageCacheSet 
} from '@bishen/tauri-plugin-redb-cache-api';

// HTTP 缓存
await cacheSet('api/users', new Uint8Array([...]));
const result = await cacheGet('api/users');
if (result) {
    const [data, timestamp] = result;
    console.log('缓存时间:', new Date(timestamp));
}

// 图片缓存
await imageCacheSet('avatar-123', 'data:image/png;base64,...');
const imageResult = await imageCacheGet('avatar-123');
if (imageResult) {
    const [dataUrl, timestamp] = imageResult;
    img.src = dataUrl;
}

// 获取缓存统计
const info = await getCacheInfo();
console.log(`${info.count} 条缓存，${info.size_bytes} 字节`);

配置选项

API 参考

HTTP 缓存

图片缓存

架构

┌─────────────────────────────────────────┐
│           JavaScript API                 │
└─────────────────────────────────────────┘
                    │
                    ▼
┌─────────────────────────────────────────┐
│         Tauri 命令 (IPC)                 │
└─────────────────────────────────────────┘
                    │
                    ▼
┌─────────────────────────────────────────┐
│   LRU 内存缓存 (100 条)                  │
│   - 热点数据快速访问                      │
└─────────────────────────────────────────┘
                    │
                    ▼
┌─────────────────────────────────────────┐
│   Redb 持久化存储                        │
│   - Zlib 压缩 (>1KB)                    │
│   - http_cache 表                       │
│   - image_cache 表                      │
└─────────────────────────────────────────┘

License / 许可证

MIT