byte-wrapper 0.1.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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

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

//! End-to-end tests verifying that schemas produced by our `JsonSchema`
//! impls are correctly consumed by typify's `x-rust-type` replacement.

#[cfg(feature = "base64")]
mod base64_tests {
    use byte_wrapper::Base64Vec;
    use schemars08::{self as schemars, JsonSchema, schema_for};

    #[expect(dead_code)]
    #[derive(JsonSchema)]
    struct HasBase64Direct {
        data: Base64Vec,
    }

    #[test]
    fn base64_direct() {
        let code = super::typify_output(&schema_for!(HasBase64Direct));
        expectorate::assert_contents(
            "tests/output/typify-base64-direct.rs",
            &code,
        );
    }

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

    #[test]
    fn base64_with_attr() {
        let code = super::typify_output(&schema_for!(HasBase64WithAttr));
        expectorate::assert_contents(
            "tests/output/typify-base64-with-attr.rs",
            &code,
        );
    }
}

#[cfg(feature = "hex")]
mod hex_tests {
    use byte_wrapper::HexArray;
    use schemars08::{self as schemars, JsonSchema, schema_for};

    #[expect(dead_code)]
    #[derive(JsonSchema)]
    struct HasHexDirect {
        checksum: HexArray<32>,
    }

    #[test]
    fn hex_direct() {
        let code = super::typify_output(&schema_for!(HasHexDirect));
        expectorate::assert_contents(
            "tests/output/typify-hex-direct.rs",
            &code,
        );
    }

    #[expect(dead_code)]
    #[derive(JsonSchema)]
    struct HasHexWithAttr {
        #[schemars(with = "HexArray<32>")]
        checksum: [u8; 32],
    }

    #[test]
    fn hex_with_attr() {
        let code = super::typify_output(&schema_for!(HasHexWithAttr));
        expectorate::assert_contents(
            "tests/output/typify-hex-with-attr.rs",
            &code,
        );
    }
}

/// Feed a root schema into typify with byte-wrapper configured as a
/// known crate, format the output with prettyplease, and return it.
#[cfg(any(feature = "base64", feature = "hex"))]
fn typify_output(root_schema: &schemars08::schema::RootSchema) -> String {
    use typify_impl::{CrateVers, TypeSpace, TypeSpaceSettings};

    let mut settings = TypeSpaceSettings::default();
    settings.with_crate(
        "byte-wrapper",
        CrateVers::Version("0.1.0".parse().unwrap()),
        None,
    );
    let mut type_space = TypeSpace::new(&settings);
    type_space.add_root_schema(root_schema.clone()).expect("added root schema");

    let tokens = quote::quote! { #type_space };
    let file = syn::parse2(tokens).expect("parsed token stream");
    prettyplease::unparse(&file)
}