pdk-cache-lib 0.0.0-alpha.3

PDK
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91

# PDK Cache Library   [![Latest Version]][crates.io] [![cache--lib msrv]][Rust 1.87]

<!-- Update links on release. -->
[Latest Version]: https://img.shields.io/badge/crates.io-v1.6.0-blue
[crates.io]: https://crates.io/crates/pdk-cache-lib
[cache--lib msrv]: https://img.shields.io/badge/pdk--cache--lib_msrv-1.87-lightgray
[Rust 1.87]: https://blog.rust-lang.org/2025/05/15/Rust-1.87.0

**pdk-cache-lib is a library that provides data caching functionality for building Flex Gateway custom policies.**

---

You may be looking for:

- [An overview of PDK](https://docs.mulesoft.com/pdk/latest/policies-pdk-overview)
- [Caching Library](https://docs.mulesoft.com/pdk/latest/policies-pdk-configure-features-caching)
- [Injecting Parameters](https://docs.mulesoft.com/pdk/latest/policies-pdk-configure-features-inject-parameters)
- [Examples](https://github.com/mulesoft/pdk-custom-policy-examples/tree/main/data-caching)
- [Release notes](https://docs.mulesoft.com/release-notes/pdk/pdk-release-notes)

## cache-lib in action

```toml
[dependencies]

# This package is included as a transitive dependency of the pdk crate.
pdk = { version = "1.6"}
```

```rust
use anyhow::Result;
use pdk::cache::{Cache, CacheBuilder, CacheError};
use pdk::hl::*;

const MAX_CACHE_ENTRIES: usize = 100;

async fn request_filter(request_state: RequestState, cache:&dyn Cache) {
    let _headers_state = request_state.into_headers_state().await;

    // Save a value to the cache
    let _save_result: Result<(), CacheError> = cache.save("example-key", "example-value".as_bytes().to_vec());

    // Retrieve value from the cache.
    let _retrieved_value: Option<Vec<u8>> = cache.get("example-key");

    // Retrieve value from the cache.
    let _deleted_value: Option<Vec<u8>> = cache.delete("example-key");

    // remove all keys from the cache.
    cache.purge();

}

async fn response_filter(response_state: ResponseState, cache:&dyn Cache) {
    let _headers_state = response_state.into_headers_state().await;

    // Save a value to the cache
    let _save_result: Result<(), CacheError> = cache.save("example-key", "example-value".as_bytes().to_vec());

    // Retrieve value from the cache.
    let _retrieved_value: Option<Vec<u8>> = cache.get("example-key");

    // Retrieve value from the cache.
    let _deleted_value: Option<Vec<u8>> = cache.delete("example-key");

    // remove all keys from the cache.
    cache.purge();

}

#[entrypoint]
// Inject the CacheBuilder to the 'configure' function.
async fn configure(launcher: Launcher, cache_builder: CacheBuilder) -> Result<()> {

    let cache = cache_builder
        .new("example-id".to_string())
        .max_entries(MAX_CACHE_ENTRIES)
        // .shared() // if uncommented the cache won't be isolated to the current policy.
        .build();

    let filter = on_request(|rs| request_filter(rs, &cache))
        .on_response(|rs| response_filter(rs, &cache));
    launcher.launch(filter).await?;
    Ok(())
}
```

#### License
<sup>
Licensed under <a href="../LICENSE.txt">Salesforce Inc License</a>.
</sup>