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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
// Run ./update-compiletest-from-doctest.pl in crate base directory
// after making any modification to compile_fail tests here.

//! This tests the `QCell` implementation without the `alloc` feature.
//!
//! You should not be able to use QCellOwnerPinned without pinning it first
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//! let mut owner1 = QCellOwnerPinned::new();
//! let id = owner1.id();
//! ```
//!
//! QCellOwnerPinned should be `!Unpin`
//!
//! ```compile_fail
//!# use qcell::QCellOwnerPinned;
//! fn is_unpin<T: Unpin>() {}
//! is_unpin::<QCellOwnerPinned>();
//! ```
//!
//! It should be impossible to copy a QCellOwnerPinned:
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//! let mut owner1 = QCellOwnerPinned::new();
//! let mut owner2 = owner1;
//! pin_mut!(owner1);  // Compile fail
//! let rc = Rc::new(owner1.as_ref().cell(100u32));
//! ```
//!
//! Including after it was pinned:
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//! let mut owner1 = QCellOwnerPinned::new();
//! pin_mut!(owner1);
//! let mut owner2 = owner1;
//! let rc = Rc::new(owner1.as_ref().cell(100u32));  // Compile fail
//! ```
//!
//! It should be impossible to clone a QCellOwnerPinned:
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//! let mut owner1 = QCellOwnerPinned::new();
//! let owner2 = owner1.clone();  // Compile fail
//! ```
//!
//! Including after it was pinned:
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//! let mut owner1 = QCellOwnerPinned::new();
//! pin_mut!(owner1);
//! let owner2 = owner1.clone();  // Compile fail
//! ```
//!
//! Two different owners can't borrow each other's cells immutably:
//!
//! ```should_panic
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//! let mut owner1 = QCellOwnerPinned::new();
//! let mut owner2 = QCellOwnerPinned::new();
//! pin_mut!(owner1);
//! pin_mut!(owner2);
//! let c1 = Rc::new(owner1.as_ref().cell(100u32));
//!
//! let c1ref = owner2.as_ref().ro(&c1);   // Panics here
//! println!("{}", *c1ref);
//! ```
//!
//! Or mutably:
//!
//! ```should_panic
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//! let mut owner1 = QCellOwnerPinned::new();
//! let mut owner2 = QCellOwnerPinned::new();
//! pin_mut!(owner1);
//! pin_mut!(owner2);
//! let c1 = Rc::new(owner1.as_ref().cell(100u32));
//!
//! let c1mutref = owner2.as_mut().rw(&c1);    // Panics here
//! println!("{}", *c1mutref);
//! ```
//!
//! You can't have two separate mutable borrows active on the same
//! owner at the same time:
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//! let mut owner = QCellOwnerPinned::new();
//! pin_mut!(owner);
//! let c1 = Rc::new(owner.as_ref().cell(100u32));
//! let c2 = Rc::new(owner.as_ref().cell(200u32));
//!
//! let c1mutref = owner.as_mut().rw(&c1);
//! let c2mutref=  owner.as_mut().rw(&c2);  // Compile error
//! *c1mutref += 1;
//! *c2mutref += 2;
//! ```
//!
//! However with `rw2()` you can do two mutable borrows at the
//! same time, since this call checks at runtime that the two
//! references don't refer to the same memory:
//!
//! ```
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//!# let mut owner = QCellOwnerPinned::new();
//!# pin_mut!(owner);
//!# let c1 = Rc::new(owner.as_ref().cell(100u32));
//!# let c2 = Rc::new(owner.as_ref().cell(200u32));
//! let (c1mutref, c2mutref) = owner.as_mut().rw2(&c1, &c2);
//! *c1mutref += 1;
//! *c2mutref += 2;
//! assert_eq!(303, owner.as_ref().ro(&c1) + owner.as_ref().ro(&c2));   // Success!
//! ```
//!
//! You can't have a mutable borrow at the same time as an immutable
//! borrow:
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//!# let mut owner = QCellOwnerPinned::new();
//!# pin_mut!(owner);
//!# let c1 = Rc::new(owner.as_ref().cell(100u32));
//!# let c2 = Rc::new(owner.as_ref().cell(200u32));
//! let c1ref = owner.as_ref().ro(&c1);
//! let c1mutref = owner.as_mut().rw(&c1);    // Compile error
//! println!("{}", *c1ref);
//! ```
//!
//! Not even if it's borrowing a different object:
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//!# let mut owner = QCellOwnerPinned::new();
//!# pin_mut!(owner);
//!# let c1 = Rc::new(owner.as_ref().cell(100u32));
//!# let c2 = Rc::new(owner.as_ref().cell(200u32));
//! let c1mutref = owner.as_mut().rw(&c1);
//! let c2ref = owner.as_ref().ro(&c2);    // Compile error
//! *c1mutref += 1;
//! ```
//!
//! Many immutable borrows at the same time is fine:
//!
//! ```
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//!# let mut owner = QCellOwnerPinned::new();
//!# pin_mut!(owner);
//!# let c1 = Rc::new(owner.as_ref().cell(100u32));
//!# let c2 = Rc::new(owner.as_ref().cell(200u32));
//! let c1ref = owner.as_ref().ro(&c1);
//! let c2ref = owner.as_ref().ro(&c2);
//! let c1ref2 = owner.as_ref().ro(&c1);
//! let c2ref2 = owner.as_ref().ro(&c2);
//! assert_eq!(600, *c1ref + *c2ref + *c1ref2 + *c2ref2);   // Success!
//! ```
//!
//! Whilst a reference is active, it's impossible to drop the `Rc`:
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//!# use pin_utils::pin_mut;
//!# let mut owner = QCellOwnerPinned::new();
//!# pin_mut!(owner);
//!# let c1 = Rc::new(owner.as_ref().cell(100u32));
//!# let c2 = Rc::new(owner.as_ref().cell(200u32));
//! let c1ref = owner.as_ref().ro(&c1);
//! drop(c1);    // Compile error
//! println!("{}", *c1ref);
//! ```
//!
//! Also, whilst a reference is active, it's impossible to call
//! anything else that uses the `owner` in an incompatible way,
//! e.g. `&mut` when there's a `&` reference:
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::{rc::Rc, pin::Pin};
//!# use pin_utils::pin_mut;
//!# let mut owner = QCellOwnerPinned::new();
//!# pin_mut!(owner);
//!# let c1 = Rc::new(owner.as_ref().cell(100u32));
//!# let c2 = Rc::new(owner.as_ref().cell(200u32));
//! fn test(o: Pin<&mut QCellOwnerPinned>) {}
//!
//! let c1ref = owner.as_ref().ro(&c1);
//! test(owner.as_mut());    // Compile error
//! println!("{}", *c1ref);
//! ```
//!
//! Or `&` when there's a `&mut` reference:
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::{rc::Rc, pin::Pin};
//!# use pin_utils::pin_mut;
//!# let mut owner = QCellOwnerPinned::new();
//!# pin_mut!(owner);
//!# let c1 = Rc::new(owner.as_ref().cell(100u32));
//!# let c2 = Rc::new(owner.as_ref().cell(200u32));
//! fn test(o: Pin<&QCellOwnerPinned>) {}
//!
//! let c1mutref = owner.as_mut().rw(&c1);
//! test(owner.as_ref());    // Compile error
//! *c1mutref += 1;
//! ```
//!
//! `QCellOwnerPinned` and `QCell` should be both
//! `Send` and `Sync` by default:
//!
//! ```
//!# use qcell::{QCell, QCellOwnerPinned};
//! fn is_send_sync<T: Send + Sync>() {}
//! is_send_sync::<QCellOwnerPinned>();
//! is_send_sync::<QCell<()>>();
//! ```
//!
//! So for example we can share a cell ref between threads (Sync), and
//! pass an owner back and forth (Send):
//!
//! ```
//!# use qcell::{QCellOwnerPinned, QCell};
//!# use pin_utils::pin_mut;
//! let mut owner = QCellOwnerPinned::new();
//! pin_mut!(owner);
//! let cell = owner.as_ref().cell(100_i32);
//!
//! *owner.as_mut().rw(&cell) += 1;
//! let cell_ref = &cell;
//! let mut owner = crossbeam::scope(move |s| {
//!     s.spawn(move |_| {
//!         *owner.as_mut().rw(cell_ref) += 2;
//!         owner
//!     }).join().unwrap()
//! }).unwrap();
//! *owner.as_mut().rw(&cell) += 4;
//! assert_eq!(*owner.as_ref().ro(&cell), 107);
//! ```
//!
//! However you can't send a cell that's still borrowed:
//!
//! ```compile_fail
//!# use qcell::{QCellOwnerPinned, QCell};
//! let mut owner = Box::pin(QCellOwnerPinned::new());
//! let cell = owner.as_ref().cell(100);
//! let val_ref = owner.as_ref().ro(&cell);
//! std::thread::spawn(move || {
//!     assert_eq!(*owner.as_ref().ro(&cell), 100);
//! }).join();
//! assert_eq!(*val_ref, 100);
//! ```
//!
//! If the contained type isn't `Sync`, though, then `QCell` shouldn't
//! be `Sync` either:
//!
//! ```compile_fail
//!# use qcell::QCell;
//!# use std::cell::Cell;
//! fn is_sync<T: Sync>() {}
//! is_sync::<QCell<Cell<i32>>>();  // Compile fail
//! ```
//!
//! If the contained type isn't `Send`, the `QCell` should be neither
//! `Sync` nor `Send`:
//!
//! ```compile_fail
//!# use qcell::QCell;
//!# use std::rc::Rc;
//! fn is_sync<T: Sync>() {}
//! is_sync::<QCell<Rc<()>>>();  // Compile fail
//! ```
//!
//! ```compile_fail
//!# use qcell::QCell;
//!# use std::rc::Rc;
//! fn is_send<T: Send>() {}
//! is_send::<QCell<Rc<()>>>();  // Compile fail
//! ```
//!
//! ```compile_fail
//!# use qcell::{QCell, QCellOwnerPinned};
//!# use std::rc::Rc;
//! let mut owner = Box::pin(QCellOwnerPinned::new());
//! let cell = owner.as_ref().cell(Rc::new(100));
//!
//! // We aren't permitted to move the Rc to another thread
//! std::thread::spawn(move || {    // Compile fail
//!     assert_eq!(100, **owner.as_ref().ro(&cell));
//! }).join();
//! ```