byte-wrapper 0.2.0

Newtype wrappers for hex byte arrays and base64 vectors, with serde and schemars support.
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

// Copyright (c) The byte-wrapper Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0

use byte_wrapper::{HexSlice, HexVec};
use schemars08::{self as schemars, JsonSchema, schema_for};
use std::borrow::Cow;

fn hex_vec_property() -> serde_json::Value {
    serde_json::json!({
        "type": "string",
        "pattern": "^([0-9a-fA-F]{2})*$",
        "x-rust-type": {
            "crate": "byte-wrapper",
            "version": "0.1.0",
            "path": "byte_wrapper::HexVec"
        }
    })
}

#[test]
fn hex_vec_schema() {
    let schema = schema_for!(HexVec);
    let actual = serde_json::to_value(&schema).expect("serialized");
    let mut expected = hex_vec_property();
    let object = expected.as_object_mut().expect("property is an object");
    object.insert(
        "$schema".into(),
        "http://json-schema.org/draft-07/schema#".into(),
    );
    object.insert("title".into(), "HexVec".into());
    assert_eq!(actual, expected);

    let slice_schema = schema_for!(HexSlice);
    assert_eq!(
        serde_json::to_value(&slice_schema).expect("serialized"),
        actual,
        "HexSlice and HexVec share a schema",
    );
}

#[expect(dead_code)]
#[derive(JsonSchema)]
struct WithHexVecAttr {
    #[schemars(with = "HexVec")]
    data: Vec<u8>,
}

#[expect(dead_code)]
#[derive(JsonSchema)]
struct WithHexVecDirect {
    data: HexVec,
}

#[expect(dead_code)]
#[derive(JsonSchema)]
struct WithHexSliceCow {
    data: Cow<'static, HexSlice>,
}

#[test]
fn with_hex_vec_fields() {
    for (title, schema) in [
        ("WithHexVecAttr", schema_for!(WithHexVecAttr)),
        ("WithHexVecDirect", schema_for!(WithHexVecDirect)),
        ("WithHexSliceCow", schema_for!(WithHexSliceCow)),
    ] {
        let actual = serde_json::to_value(&schema).expect("serialized");
        let expected = serde_json::json!({
            "$schema": "http://json-schema.org/draft-07/schema#",
            "title": title,
            "type": "object",
            "required": ["data"],
            "properties": {
                "data": hex_vec_property(),
            }
        });
        assert_eq!(actual, expected, "schema for {title}");
    }
}