xberg 1.0.1

High-performance document intelligence library for Rust. Extract text, metadata, and structured data from PDFs, Office documents, images, and 98 formats and 306 programming languages via tree-sitter code intelligence with async/sync APIs.
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

//! The [`CacheBackend`] seam: an optional, content-addressed byte cache.
//!
//! The in-core default is [`NoopCache`], which stores nothing — exactly the
//! behavior xberg exhibits today, where the extraction path performs no
//! engine-level result caching. Alternative backends (Redis, on-disk, an
//! in-memory LRU) implement this trait and are injected via
//! [`EngineBuilder::with_cache_backend`](super::super::EngineBuilder::with_cache_backend).

use std::time::Duration;

use async_trait::async_trait;

/// A content-addressed byte cache keyed by opaque string keys.
///
/// # Thread safety
///
/// Implementations are `Send + Sync + 'static` and held behind
/// `Arc<dyn CacheBackend>`; they may be called concurrently.
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
pub trait CacheBackend: Send + Sync + 'static {
    /// Fetch the bytes stored under `key`, or `None` if absent or expired.
    async fn get(&self, key: &str) -> Option<Vec<u8>>;

    /// Store `value` under `key`, optionally expiring after `ttl`.
    async fn put(&self, key: &str, value: Vec<u8>, ttl: Option<Duration>);
}

/// In-core default: a cache that stores nothing and never hits.
///
/// This reproduces today's behavior exactly — the default extraction path does
/// no engine-level caching, so [`get`](CacheBackend::get) always returns `None`
/// and [`put`](CacheBackend::put) is inert.
#[derive(Debug, Default, Clone, Copy)]
pub struct NoopCache;

#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
impl CacheBackend for NoopCache {
    async fn get(&self, _key: &str) -> Option<Vec<u8>> {
        None
    }

    async fn put(&self, _key: &str, _value: Vec<u8>, _ttl: Option<Duration>) {}
}