instruct-macros 0.1.8

instruct-macros are a collection of simple macros that we're using in Instructor-AI to generate json schema from Serde Objects
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

extern crate instruct_macros_types;

use instruct_macros::InstructMacro;
use instruct_macros_types::{
    InstructMacro, InstructMacroResult, Parameter, ParameterInfo, StructInfo,
};

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

    #[test]
    fn test_vec_simple_type() {
        #[derive(InstructMacro, Debug)]
        #[description("This is a struct with Option types")]
        struct Numbers {
            #[description("This is a list of numbers")]
            pub numbers: Vec<i32>,
        }

        let info = Numbers::get_info();

        let desired_struct = StructInfo {
            name: "Numbers".to_string(),
            description: "This is a struct with Option types".to_string(),
            parameters: vec![Parameter::Field(ParameterInfo {
                name: "numbers".to_string(),
                r#type: "i32".to_string(),
                comment: "This is a list of numbers".to_string(),
                is_optional: false,
                is_list: true,
            })],
            is_optional: false,
            is_list: false,
        };

        let info_struct = match info {
            InstructMacroResult::Struct(s) => s,
            _ => panic!("Expected StructInfo"),
        };

        assert_eq!(info_struct, desired_struct);
    }

    #[test]
    fn test_vec_struct() {
        #[derive(InstructMacro, Debug)]
        #[description("This is a struct with Option types")]
        struct User {
            #[description("This is a list of numbers")]
            pub name: String,
        }

        #[derive(InstructMacro, Debug)]
        #[description("This is a struct with Option types")]
        struct Users {
            #[description("This is a list of users")]
            pub users: Vec<User>,
        }

        let info = Users::get_info();

        let desired_struct = StructInfo {
            name: "Users".to_string(),
            description: "This is a struct with Option types".to_string(),
            parameters: vec![Parameter::Struct(StructInfo {
                name: "users".to_string(),
                description: "This is a list of users".to_string(),
                parameters: vec![Parameter::Field(ParameterInfo {
                    name: "name".to_string(),
                    r#type: "String".to_string(),
                    comment: "This is a list of numbers".to_string(),
                    is_optional: false,
                    is_list: false,
                })],
                is_optional: false,
                is_list: true,
            })],
            is_optional: false,
            is_list: false,
        };
        let info_struct = match info {
            InstructMacroResult::Struct(s) => s,
            _ => panic!("Expected StructInfo"),
        };

        assert_eq!(info_struct, desired_struct);
    }
}