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
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
//! Enums shared across languages: each value is a named singleton of an
//! object type whose parent is [`EnumObj`]. [`EnumRef`] looks values up;
//! [`reflection::EnumDef`](crate::reflection::EnumDef) registers them.
use crateObject;
use crate;
use crateEnumAttrMap;
use crate;
use crateAnyCompatible;
use crate::;
/// The object behind every enum value: its name and the index the registry
/// assigned it. An enum type's object embeds it as its parent,
/// `base_: EnumObj`.
/// A reference to an enum value: one named singleton of an enum type,
/// registered once and shared with every language.
///
/// [`get`](Self::get) looks a value up by name. Each name has one value, so
/// equality is identity: compare values with
/// [`same_as`](ObjectRefCore::same_as).
/// [`EnumDef`](crate::reflection::EnumDef) registers values and their
/// attributes, and [`attr_map`](Self::attr_map) reads an attribute.
///
/// The stub generator implements it for the enum types it binds. A
/// hand-written reference implements it when its object's parent is
/// [`EnumObj`].
///
/// # Examples
///
/// ```standalone_crate
/// use tvm_ffi::derive::{Object, ObjectRef};
/// use tvm_ffi::reflection::EnumDef;
/// use tvm_ffi::{EnumRef, ObjectArc, ObjectRefCore};
/// use tvm_ffi::enum_ref::EnumObj;
///
/// #[repr(C)]
/// #[derive(Object)]
/// #[object(type_key = "my_ext.Color", register, final, immutable)]
/// pub struct ColorObj {
/// base_: EnumObj,
/// }
///
/// #[derive(Clone, ObjectRef)]
/// pub struct Color {
/// data: ObjectArc<ColorObj>,
/// }
///
/// impl EnumRef for Color {}
///
/// EnumDef::<Color>::new("red")?;
///
/// let red = Color::get("red")?;
/// assert_eq!(red.name(), "red");
/// assert!(red.same_as(&Color::get("red")?));
/// # Ok::<(), tvm_ffi::Error>(())
/// ```