cairo-lang-plugins 2.1.2

Cairo core plugin implementations.
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

//! > Test expansion of panic_with.

//! > test_runner_name
test_expand_plugin

//! > cairo_code
#[panic_with('1', foo_improved)]
extern fn foo(a: felt252, ref b: other) -> Option::<()> implicits(RangeCheck, GasBuiltin) nopanic;

#[panic_with('2', bar_changed)]
extern fn bar() -> Result::<felt252, Err> nopanic;

#[panic_with('3', non_extern_stuff)]
fn non_extern(_a: some_type) -> Option::<(felt252, other)> nopanic {
    (4, 56)
}

#[panic_with('4', generic_panic)]
extern fn generic<T>(t: T, v: felt252) -> Result::<T, Err> nopanic;

#[panic_with('5', wrapped_possibly_panic)]
fn possibly_panic() -> Result::<felt252, Err> { Result::<felt252, Err>::Ok(1) }

//! > generated_cairo_code
#[panic_with('1', foo_improved)]
extern fn foo(a: felt252, ref b: other) -> Option::<()> implicits(RangeCheck, GasBuiltin) nopanic;

fn foo_improved(a: felt252, ref b: other) -> () {
    match foo(a, ref b) {
        Option::Some (v) => {
            v
        },
        Option::None (v) => {
            let mut data = array::array_new::<felt252>();
            array::array_append::<felt252>(ref data, '1');
            panic(data)
        },
    }
}


#[panic_with('2', bar_changed)]
extern fn bar() -> Result::<felt252, Err> nopanic;

fn bar_changed() -> felt252 {
    match bar() {
        Result::Ok (v) => {
            v
        },
        Result::Err (v) => {
            let mut data = array::array_new::<felt252>();
            array::array_append::<felt252>(ref data, '2');
            panic(data)
        },
    }
}


#[panic_with('3', non_extern_stuff)]
fn non_extern(_a: some_type) -> Option::<(felt252, other)> nopanic {
    (4, 56)
}

fn non_extern_stuff(_a: some_type) -> (felt252, other) {
    match non_extern(_a) {
        Option::Some (v) => {
            v
        },
        Option::None (v) => {
            let mut data = array::array_new::<felt252>();
            array::array_append::<felt252>(ref data, '3');
            panic(data)
        },
    }
}


#[panic_with('4', generic_panic)]
extern fn generic<T>(t: T, v: felt252) -> Result::<T, Err> nopanic;

fn generic_panic<T>(t: T, v: felt252) -> T {
    match generic(t, v) {
        Result::Ok (v) => {
            v
        },
        Result::Err (v) => {
            let mut data = array::array_new::<felt252>();
            array::array_append::<felt252>(ref data, '4');
            panic(data)
        },
    }
}


#[panic_with('5', wrapped_possibly_panic)]
fn possibly_panic() -> Result::<felt252, Err> { Result::<felt252, Err>::Ok(1) }
fn wrapped_possibly_panic() -> felt252 {
    match possibly_panic() {
        Result::Ok (v) => {
            v
        },
        Result::Err (v) => {
            let mut data = array::array_new::<felt252>();
            array::array_append::<felt252>(ref data, '5');
            panic(data)
        },
    }
}

//! > expected_diagnostics

//! > ==========================================================================

//! > Test diagnostics of panic with.

//! > test_runner_name
test_expand_plugin

//! > cairo_code
#[panic_with(123, foo_bad_err_code)]
extern fn foo(a: felt252, b: other) -> Option::<()> implicits(RangeCheck, GasBuiltin) nopanic;

#[panic_with(missing_args)]
extern fn non_extern(_a: some_type) -> Option::<(felt252, other)> nopanic;

#[panic_with(missing_args)]
extern fn bad_ret_type(_a: some_type) -> felt252 nopanic;

#[panic_with('2', bar_changed)]
#[panic_with('3', bar_changed)]
extern fn bar() -> Result::<felt252, Err> nopanic;

//! > generated_cairo_code
#[panic_with(123, foo_bad_err_code)]
extern fn foo(a: felt252, b: other) -> Option::<()> implicits(RangeCheck, GasBuiltin) nopanic;


#[panic_with(missing_args)]
extern fn non_extern(_a: some_type) -> Option::<(felt252, other)> nopanic;


#[panic_with(missing_args)]
extern fn bad_ret_type(_a: some_type) -> felt252 nopanic;


#[panic_with('2', bar_changed)]
#[panic_with('3', bar_changed)]
extern fn bar() -> Result::<felt252, Err> nopanic;

//! > expected_diagnostics
error: Failed to extract panic data attribute
 --> dummy_file.cairo:1:1
#[panic_with(123, foo_bad_err_code)]
^**********************************^

error: Failed to extract panic data attribute
 --> dummy_file.cairo:4:1
#[panic_with(missing_args)]
^*************************^

error: Currently only wrapping functions returning an Option<T> or Result<T, E>
 --> dummy_file.cairo:8:39
extern fn bad_ret_type(_a: some_type) -> felt252 nopanic;
                                      ^********^

error: `#[panic_with]` cannot be applied multiple times to the same item.
 --> dummy_file.cairo:11:1
#[panic_with('3', bar_changed)]
^*****************************^