vld-integration-common 0.6.0

Shared helpers for vld integration crates (internal)
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

//! # vld-integration-common — shared helpers for `vld` integration crates
//!
//! **Internal crate** with no stable API of its own: depend on the
//! integration crate you need (`vld-dioxus`, `vld-leptos`, `vld-tauri`,
//! `vld-clap`, `vld-sqlx`, `vld-diesel`, `vld-sea`, `vld-surrealdb`), which
//! re-exports what it uses from here.
//!
//! - [`format_path`] / [`flatten_issues`] — clean issue paths (`user.email`,
//!   `items[0].name`, no leading dot);
//! - [`form`] — `VldServerError`, `FieldError`, `check_field`,
//!   [`validate_args!`] (re-exported by `vld-dioxus` / `vld-leptos`);
//! - [`db`] — hidden macros that generate each database crate's error type,
//!   `Validated<S, T>` and the `VldText` / `VldInt` / `VldFloat` / `VldBool`
//!   column wrappers inside that crate (so it can implement its own database
//!   traits without orphan-rule conflicts).
//!
//! Guide: <https://s00d.github.io/vld/integrations/shared/integration-common>
#![warn(missing_docs)]

use vld::error::{PathSegment, VldError};

pub mod db;
pub mod form;

/// Format a validation path as a clean dotted path: `user.email`, `items[0].name`.
///
/// No leading dot; an empty path gives an empty string.
///
/// ```
/// use vld::error::PathSegment;
/// let p = [PathSegment::Field("items".into()), PathSegment::Index(0), PathSegment::Field("name".into())];
/// assert_eq!(vld_integration_common::format_path(&p), "items[0].name");
/// ```
pub fn format_path(path: &[PathSegment]) -> String {
    let mut out = String::new();
    for seg in path {
        match seg {
            PathSegment::Field(name) => {
                if !out.is_empty() {
                    out.push('.');
                }
                out.push_str(name);
            }
            PathSegment::Index(idx) => {
                out.push('[');
                out.push_str(&idx.to_string());
                out.push(']');
            }
        }
    }
    out
}

/// Flatten a [`VldError`] into `(path, message)` pairs using [`format_path`].
pub fn flatten_issues(err: &VldError) -> Vec<(String, String)> {
    err.issues
        .iter()
        .map(|i| (format_path(&i.path), i.message.clone()))
        .collect()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn format_path_has_no_leading_dot() {
        let p = vec![
            PathSegment::Field("user".into()),
            PathSegment::Field("email".into()),
        ];
        assert_eq!(format_path(&p), "user.email");
        assert_eq!(format_path(&[PathSegment::Index(2)]), "[2]");
        assert_eq!(format_path(&[]), "");
    }
}