vld-salvo 0.3.0

Salvo integration for the vld validation library
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

[![Crates.io](https://img.shields.io/crates/v/vld-salvo?style=for-the-badge)](https://crates.io/crates/vld-salvo)
[![docs.rs](https://img.shields.io/docsrs/vld-salvo?style=for-the-badge)](https://docs.rs/vld-salvo)
[![License](https://img.shields.io/badge/license-MIT-green?style=for-the-badge)](https://github.com/s00d/vld/blob/main/LICENSE)
[![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-blue?style=for-the-badge)](https://github.com/s00d/vld)
[![GitHub issues](https://img.shields.io/badge/github-issues-orange?style=for-the-badge)](https://github.com/s00d/vld/issues)
[![GitHub stars](https://img.shields.io/badge/github-stars-yellow?style=for-the-badge)](https://github.com/s00d/vld/stargazers)

# vld-salvo

[Salvo](https://salvo.rs) integration for the **vld** validation library.

## Features

All extractors implement Salvo's `Extractible` trait and can be used
**directly as `#[handler]` parameters** — just like Salvo's built-in
`JsonBody` or `PathParam`:

| Extractor | Source | Description |
|-----------|--------|-------------|
| `VldJson<T>` | JSON body | Validates JSON request body |
| `VldQuery<T>` | Query string | Validates URL query parameters |
| `VldForm<T>` | Form body | Validates URL-encoded form body |
| `VldPath<T>` | Path params | Validates path parameters |
| `VldHeaders<T>` | HTTP headers | Validates request headers |
| `VldCookie<T>` | Cookie header | Validates cookie values |

All extractors implement `Deref<Target = T>` so you access fields
directly (e.g. `body.name` instead of `body.0.name`).

`VldSalvoError` implements Salvo's `Writer` trait — validation
failures render as `422 Unprocessable Entity` with a JSON error body.

## Installation

```toml
[dependencies]
vld-salvo = "0.1"
vld = "0.1"
salvo = "0.89"
serde_json = "1"
```

## Quick Start

```rust
use salvo::prelude::*;
use vld_salvo::prelude::*;

vld::schema! {
    #[derive(Debug, Clone, serde::Serialize)]
    pub struct CreateUser {
        pub name: String  => vld::string().min(2).max(50),
        pub email: String => vld::string().email(),
    }
}

// VldJson<T> is used directly as a handler parameter!
#[handler]
async fn create(body: VldJson<CreateUser>, res: &mut Response) {
    // Deref lets you access fields directly
    res.render(Json(serde_json::json!({"name": body.name})));
}

#[tokio::main]
async fn main() {
    let router = Router::with_path("users").post(create);
    let acceptor = TcpListener::new("0.0.0.0:5800").bind().await;
    Server::new(acceptor).serve(router).await;
}
```

## Path Parameters

Salvo uses `{name}` syntax for path parameters:

```rust,ignore
vld::schema! {
    #[derive(Debug, Clone)]
    pub struct UserId {
        pub id: i64 => vld::number().int().min(1),
    }
}

#[handler]
async fn get_user(p: VldPath<UserId>, res: &mut Response) {
    res.render(Json(serde_json::json!({"id": p.id})));
}

// Router::with_path("users/{id}").get(get_user)
```

## Multiple Extractors

Combine several extractors in a single handler:

```rust,ignore
#[handler]
async fn handler(
    path: VldPath<UserId>,
    query: VldQuery<Pagination>,
    headers: VldHeaders<AuthHeaders>,
    body: VldJson<UpdateUser>,
    res: &mut Response,
) {
    // path.id, query.page, headers.authorization, body.name
}
```

## Error Response Format

```json
{
  "error": "Validation failed",
  "issues": [
    { "path": ".name", "message": "String must be at least 2 characters" }
  ]
}
```

## Running Examples

```bash
cargo run -p vld-salvo --example salvo_basic
```

### Example Requests

```bash
# Create user (valid)
curl -X POST http://localhost:5800/users \
  -H 'Content-Type: application/json' \
  -d '{"name":"Alice","email":"alice@example.com","age":30}'

# Create user (invalid — triggers 422)
curl -X POST http://localhost:5800/users \
  -H 'Content-Type: application/json' \
  -d '{"name":"A","email":"bad"}'

# Get user by id
curl http://localhost:5800/users/42

# Search (query params)
curl "http://localhost:5800/search?q=hello&page=1&limit=10"

# Health check
curl http://localhost:5800/health
```

## License

MIT