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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*
* 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.
*/
//! Structural equality and hashing of values.
use crateAccessPath;
use crate::;
/// Options of structural equality and hashing.
///
/// See also [`structural_equal_with`], [`structural_hash_with`] and
/// [`get_first_structural_mismatch_with`].
/// Whether two values are structurally equal: they have the same structure
/// and content, compared recursively through containers and reflected
/// fields, not by identity.
///
/// Objects compare as their [`SEqHashKind`](crate::reflection::SEqHashKind) declares.
///
/// # Arguments
///
/// * `lhs` - The left value.
/// * `rhs` - The right value.
///
/// # Returns
///
/// Whether the values are structurally equal.
///
/// # Errors
///
/// Returns an error if an object in either value does not support structural
/// equality.
///
/// # Examples
///
/// ```standalone_crate
/// use tvm_ffi::derive::ObjectRef;
/// use tvm_ffi::{rs_object, structural_equal, Array, Object, ObjectArc};
///
/// #[rs_object(type_key = "my_ext.MyPair", final, s_eq_hash_kind = "TreeNode")]
/// pub struct MyPairObj {
/// base_: Object,
/// pub first: i64,
/// pub second: Array<i64>,
/// }
///
/// #[derive(Clone, ObjectRef)]
/// pub struct MyPair {
/// data: ObjectArc<MyPairObj>,
/// }
///
/// let pair = |second: Vec<i64>| {
/// MyPair::from_object(MyPairObj::new(Object::new(), 1, Array::from_vec(second)))
/// };
/// assert!(structural_equal(&pair(vec![2, 3]), &pair(vec![2, 3]))?);
/// assert!(!structural_equal(&pair(vec![2, 3]), &pair(vec![2, 4]))?);
/// # Ok::<(), tvm_ffi::Error>(())
/// ```
/// As [`structural_equal`], with [`StructuralOptions`].
/// The structural hash of a value, consistent with [`structural_equal`]:
/// structurally equal values have the same hash.
///
/// # Arguments
///
/// * `value` - The value to hash.
///
/// # Returns
///
/// The hash.
///
/// # Errors
///
/// Returns an error if an object in the value does not support structural
/// hashing.
///
/// See also [`structural_equal`].
/// As [`structural_hash`], with [`StructuralOptions`].
/// The first place where two values are not structurally equal, as the
/// [`AccessPath`] of that place in each value.
///
/// # Arguments
///
/// * `lhs` - The left value.
/// * `rhs` - The right value.
///
/// # Returns
///
/// `None` if the values are structurally equal, else the paths of the first
/// mismatch in `lhs` and in `rhs`.
///
/// # Errors
///
/// Returns an error if an object in either value does not support structural
/// equality.
///
/// See also [`structural_equal`].
/// As [`get_first_structural_mismatch`], with [`StructuralOptions`].