pdk 0.0.0-alpha.2

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

# Policy Development Kit (PDK)   [![Latest Version]][crates.io] [![pdk 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
[pdk msrv]: https://img.shields.io/badge/pdk_msrv-1.87-lightgray
[Rust 1.87]: https://blog.rust-lang.org/2025/05/15/Rust-1.87.0

**pdk is the primary crate for building Flex Gateway custom policies.**

---

You may be looking for:

- [An overview of PDK](https://docs.mulesoft.com/pdk/latest/policies-pdk-overview)
- [Examples](https://github.com/mulesoft/pdk-custom-policy-examples)
- [Release notes](https://docs.mulesoft.com/release-notes/pdk/pdk-release-notes)

## pdk in action

```toml
[dependencies]
pdk = { version = "1.6" }
```

```rust
use anyhow::{anyhow, Result};

use pdk::hl::*;

use crate::generated::config::Config;

// handle the headers on the incoming http request.
async fn request_filter(request_state: RequestState, _config: &Config) {
    let headers_state = request_state.into_headers_state().await;

    // Replace the current value of the header 'example-replaced-header' with the value 'example-replaced-value'
    headers_state.handler().set_header("example-replaced-header", "example-replaced-value");
}

#[entrypoint]
async fn configure(launcher: Launcher, Configuration(bytes): Configuration) -> Result<()> {
    let config: Config = serde_json::from_slice(&bytes).map_err(|err| {
        anyhow!(
            "Failed to parse configuration '{}'. Cause: {}",
            String::from_utf8_lossy(&bytes),
            err
        )
    })?;

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

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