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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Scoped thread-local storage
//!
//! This module provides the ability to generate *scoped* thread-local
//! variables. In this sense, scoped indicates that thread local storage
//! actually stores a reference to a value, and this reference is only placed
//! in storage for a scoped amount of time.
//!
//! There are no restrictions on what types can be placed into a scoped
//! variable, but all scoped variables are initialized to the equivalent of
//! null. Scoped thread local storage is useful when a value is present for a known
//! period of time and it is not required to relinquish ownership of the
//! contents.
//!
//! # Examples
//!
//! ## Basic usage
//!
//! ```
//! use scoped_tls_hkt::scoped_thread_local;
//!
//! scoped_thread_local!(static FOO: u32);
//!
//! # fn main() {
//! // Initially each scoped slot is empty.
//! assert!(!FOO.is_set());
//!
//! // When inserting a value, the value is only in place for the duration
//! // of the closure specified.
//! FOO.set(&1, || {
//!     FOO.with(|slot| {
//!         assert_eq!(*slot, 1);
//!     });
//! });
//! # }
//! ```
//!
//! ## Mutable value
//!
//! ```
//! use scoped_tls_hkt::scoped_thread_local;
//!
//! scoped_thread_local!(static mut FOO: u32);
//!
//! # fn main() {
//! // Initially each scoped slot is empty.
//! assert!(!FOO.is_set());
//!
//! // When inserting a value, the value is only in place for the duration
//! // of the closure specified.
//! let mut x = 1;
//! FOO.set(&mut x, || {
//!     FOO.with(|slot| {
//!         assert_eq!(*slot, 1);
//!
//!         // We can mutate the value
//!         *slot = 42;
//!     });
//! });
//!
//! // Changes will be visible externally
//! assert_eq!(x, 42);
//! # }
//! ```
//!
//! ## Higher-kinded types
//!
//! ```
//! use scoped_tls_hkt::scoped_thread_local;
//!
//! // Must implement Copy
//! #[derive(Copy, Clone)]
//! struct Foo<'a> {
//!     x: &'a str, // Lifetime is covariant
//!     y: i32,
//! }
//!
//! scoped_thread_local!(static FOO: for<'a> Foo<'a>);
//!
//! # fn main() {
//! // Initially each scoped slot is empty.
//! assert!(!FOO.is_set());
//!
//! // When inserting a value, the value is only in place for the duration
//! // of the closure specified.
//! FOO.set(Foo { x: "Hello", y: 42 }, || {
//!     FOO.with(|slot| {
//!         assert_eq!(slot.x, "Hello");
//!         assert_eq!(slot.y, 42);
//!     });
//! });
//! # }
//! ```
//!
//! ## Mutable higher-kinded types
//!
//! For mutable HKTs, the types must implement the [`ReborrowMut`](ReborrowMut)
//! trait, and the `Result` associated type should be the `Self` type, but with
//! the lifetime substituted with the trait's lifetime parameter.
//!
//! The [`ReborrowMut`](ReborrowMut) trait is implemented automatically for
//! many built-in types, including primitive types, references, mutable
//! references and tuples (up to length 10). Where this is insufficient, you
//! can implement the trait yourself: doing so should not require any unsafe
//! code.
//!
//! ```
//! use scoped_tls_hkt::scoped_thread_local;
//!
//! scoped_thread_local!(static mut FOO: for<'a> (&'a mut i32, &'a mut f32));
//!
//! # fn main() {
//! // Initially each scoped slot is empty.
//! assert!(!FOO.is_set());
//!
//! // References to local variables can be stored.
//! let mut x = 1;
//! let mut y = 2.0;
//! FOO.set((&mut x, &mut y), || {
//!     FOO.with(|(u, v)| {
//!         assert_eq!(*u, 1);
//!         assert_eq!(*v, 2.0);
//!         *u = 42;
//!     });
//! });
//!
//! assert_eq!(x, 42);
//! # }
//! ```

#![deny(missing_docs, warnings)]

use std::cell::Cell;
use std::thread::LocalKey;

/// Trait representing the act of "reborrowing" a mutable reference
/// to produce a new one with a shorter lifetime.
pub trait ReborrowMut<'a> {
    /// Type of the shorter reference
    type Result;

    /// Produces a new reference with lifetime 'a
    fn reborrow_mut(&'a mut self) -> Self::Result;
}

impl<'a, 'b: 'a, T: ?Sized> ReborrowMut<'a> for &'b mut T {
    type Result = &'a mut T;
    fn reborrow_mut(&'a mut self) -> Self::Result {
        &mut **self
    }
}

impl<'a, 'b: 'a, T: ?Sized> ReborrowMut<'a> for &'b T {
    type Result = &'a T;
    fn reborrow_mut(&'a mut self) -> Self::Result {
        &**self
    }
}

macro_rules! define_tuple_reborrow {
    (@expand $($t:ident),*) => {
        impl<'a, $($t,)*> ReborrowMut<'a> for ($($t,)*)
        where
            $($t: ReborrowMut<'a> + 'a),*
        {
            type Result = ($($t::Result,)*);
            fn reborrow_mut(&'a mut self) -> Self::Result {
                #[allow(non_snake_case)]
                let ($($t,)*) = self;
                ($($t.reborrow_mut(),)*)
            }
        }
    };
    () => {
        define_tuple_reborrow!(@expand);
    };
    ($t:ident $(, $ts:ident)*) => {
        define_tuple_reborrow!(@expand $t $(, $ts)*);
        define_tuple_reborrow!($($ts),*);
    };
}

macro_rules! define_copy_reborrow {
    ($($t:ty,)*) => {
        $(
            impl<'a> ReborrowMut<'a> for $t {
                type Result = $t;
                fn reborrow_mut(&'a mut self) -> Self::Result {
                    *self
                }
            }
        )*
    }
}

define_tuple_reborrow!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10);
define_copy_reborrow! {
    bool, char, isize, usize,
    i8, u8, i16, u16, i32, u32, i64, u64, i128, u128,
    f32, f64,
    std::any::TypeId,
}

/// The macro. See the module level documentation for the description and examples.
#[macro_export]
macro_rules! scoped_thread_local {
    ($(#[$attrs:meta])* $vis:vis static $name:ident: $(#[$tattrs:meta])* for<$lt:lifetime> $ty:ty) => (
        $(#[$tattrs])*
        #[allow(non_camel_case_types)]
        $vis struct $name<$lt> where ::std::cell::Cell<::std::option::Option<$ty>>: 'static {
            inner: &$lt ::std::thread::LocalKey<::std::cell::Cell<::std::option::Option<$ty>>>,
        }
        $(#[$attrs])*
        $vis static $name: $name<'static> = {
            type Hkt<$lt> = $ty;

            {
                use ::std::cell::Cell;
                use ::std::option::Option;
                use ::std::marker::Sync;
                use ::std::ops::{FnOnce, Drop};
                use ::std::thread::LocalKey;

                thread_local!(static FOO: Cell<Option<Hkt<'static>>> = {
                    Cell::new(None)
                });

                unsafe impl Sync for $name<'static> {}

                unsafe fn cast_to_static(x: Hkt<'_>) -> Hkt<'static> {
                    std::mem::transmute(x)
                }

                // This wrapper helps to ensure that the 'static lifetime is not visible
                // to the safe code.
                fn cast_from_static<'a, 'b>(x: &'a Hkt<'static>) -> Hkt<'b> where 'a: 'b {
                    *x
                }

                impl $name<'static> {
                    pub fn set<F, R>(&'static self, t: Hkt<'_>, f: F) -> R
                        where F: FnOnce() -> R
                    {
                        struct Reset {
                            key: &'static LocalKey<Cell<Option<Hkt<'static>>>>,
                            val: Option<Hkt<'static>>,
                        }
                        impl Drop for Reset {
                            fn drop(&mut self) {
                                self.key.with(|c| c.set(self.val.take()));
                            }
                        }
                        let prev = self.inner.with(|c| {
                            // Safety: we are only changing the lifetime. We enforce the
                            // lifetime constraints via the `Reset` struct.
                            c.replace(Some(unsafe { cast_to_static(t) }))
                        });
                        let _reset = Reset { key: self.inner, val: prev };
                        f()
                    }

                    pub fn with<F, R>(&'static self, f: F) -> R
                        where F: FnOnce(Hkt<'_>) -> R
                    {
                        let val = self.inner.with(|c| c.get());
                        let val = val.expect("cannot access a scoped thread local variable without calling `set` first");

                        // This also asserts that Hkt is covariant
                        f(cast_from_static(&val))
                    }

                    /// Test whether this TLS key has been `set` for the current thread.
                    pub fn is_set(&'static self) -> bool {
                        self.inner.with(|c| c.get().is_some())
                    }
                }
                $name {
                    inner: &FOO,
                }
            }
        };
    );
    ($(#[$attrs:meta])* $vis:vis static mut $name:ident: $(#[$tattrs:meta])* for<$lt:lifetime> $ty:ty) => (
        $(#[$tattrs])*
        #[allow(non_camel_case_types)]
        $vis struct $name<$lt> where ::std::cell::Cell<::std::option::Option<$ty>>: 'static {
            inner: &$lt ::std::thread::LocalKey<::std::cell::Cell<::std::option::Option<$ty>>>,
        }
        $(#[$attrs])*
        $vis static $name: $name<'static> = {
            type Hkt<$lt> = $ty;

            {
                use ::std::cell::Cell;
                use ::std::option::Option;
                use ::std::marker::Sync;
                use ::std::ops::{FnOnce, Drop};
                use ::std::thread::LocalKey;

                use $crate::ReborrowMut;

                thread_local!(static FOO: Cell<Option<Hkt<'static>>> = {
                    Cell::new(None)
                });

                unsafe impl Sync for $name<'static> {}

                unsafe fn cast_to_static(x: Hkt<'_>) -> Hkt<'static> {
                    std::mem::transmute(x)
                }

                // This wrapper helps to ensure that the 'static lifetime is not visible
                // to the safe code.
                fn cast_from_static<'a, 'b>(x: &'a mut Hkt<'static>) -> Hkt<'b> where 'a: 'b {
                    ReborrowMut::reborrow_mut(x)
                }

                impl $name<'static> {
                    fn replace<F, R>(&'static self, value: Option<Hkt<'_>>, f: F) -> R
                        where F: FnOnce(Option<Hkt<'_>>) -> R
                    {
                        struct Reset {
                            key: &'static LocalKey<Cell<Option<Hkt<'static>>>>,
                            val: Option<Hkt<'static>>,
                        }
                        impl Drop for Reset {
                            fn drop(&mut self) {
                                self.key.with(|c| c.set(self.val.take()));
                            }
                        }
                        let prev = self.inner.with(move |c| {
                            // Safety: we are only changing the lifetime. We enforce the
                            // lifetime constraints via the `Reset` struct.
                            c.replace(value.map(|x| unsafe { cast_to_static(x) }))
                        });
                        let mut reset = Reset { key: self.inner, val: prev };
                        f(reset.val.as_mut().map(cast_from_static))
                    }

                    /// Inserts a value into this scoped thread local storage slot for a
                    /// duration of a closure.
                    pub fn set<F, R>(&'static self, t: Hkt<'_>, f: F) -> R
                        where F: FnOnce() -> R
                    {
                        self.replace(Some(t), |_| f())
                    }

                    /// Gets a value out of this scoped variable.
                    ///
                    /// This function takes a closure which receives the value of this
                    /// variable. For the duration of the closure, the key will appear
                    /// unset.
                    ///
                    /// # Panics
                    ///
                    /// This function will panic if `set` has not previously been called,
                    /// or if the call is nested inside another (multiple mutable borrows
                    /// of the same value are not allowed).
                    ///
                    pub fn with<F, R>(&'static self, f: F) -> R
                        where F: FnOnce(Hkt<'_>) -> R
                    {
                        self.replace(None, |val| f(val.expect("cannot access a scoped thread local variable without calling `set` first")))
                    }

                    /// Test whether this TLS key has been `set` for the current thread.
                    pub fn is_set(&'static self) -> bool {
                        self.replace(None, |prev| prev.is_some())
                    }
                }
                $name {
                    inner: &FOO,
                }
            }
        };
    );
    ($(#[$attrs:meta])* $vis:vis static $name:ident: $ty:ty) => (
        $(#[$attrs])*
        $vis static $name: $crate::ScopedKey<$ty> = $crate::ScopedKey {
            inner: {
                thread_local!(static FOO: ::std::cell::Cell<::std::option::Option<&'static $ty>> = {
                    ::std::cell::Cell::new(None)
                });
                &FOO
            },
        };
    );
    ($(#[$attrs:meta])* $vis:vis static mut $name:ident: $ty:ty) => (
        $(#[$attrs])*
        $vis static $name: $crate::ScopedKeyMut<$ty> = $crate::ScopedKeyMut {
            inner: {
                thread_local!(static FOO: ::std::cell::Cell<::std::option::Option<&'static mut $ty>> = {
                    ::std::cell::Cell::new(None)
                });
                &FOO
            },
        };
    );
}

/// Type representing a thread local storage key corresponding to a reference
/// to the type parameter `T`.
///
/// Keys are statically allocated and can contain a reference to an instance of
/// type `T` scoped to a particular lifetime. Keys provides two methods, `set`
/// and `with`, both of which currently use closures to control the scope of
/// their contents.
pub struct ScopedKey<T: ?Sized + 'static> {
    #[doc(hidden)]
    pub inner: &'static LocalKey<Cell<Option<&'static T>>>,
}

unsafe impl<T: ?Sized + 'static> Sync for ScopedKey<T> {}

unsafe fn cast_to_static<T: ?Sized + 'static>(x: &T) -> &'static T {
    std::mem::transmute(x)
}

// This wrapper helps to ensure that the 'static lifetime is not visible
// to the safe code.
fn cast_from_static<'a, 'b, T: ?Sized + 'static>(x: &'a &T) -> &'b T
where
    'a: 'b,
{
    *x
}

impl<T: ?Sized + 'static> ScopedKey<T> {
    /// Inserts a value into this scoped thread local storage slot for a
    /// duration of a closure.
    ///
    /// While `cb` is running, the value `t` will be returned by `get` unless
    /// this function is called recursively inside of `cb`.
    ///
    /// Upon return, this function will restore the previous value, if any
    /// was available.
    ///
    /// # Examples
    ///
    /// ```
    /// use scoped_tls_hkt::scoped_thread_local;
    ///
    /// scoped_thread_local!(static FOO: u32);
    ///
    /// # fn main() {
    /// FOO.set(&100, || {
    ///     let val = FOO.with(|v| *v);
    ///     assert_eq!(val, 100);
    ///
    ///     // set can be called recursively
    ///     FOO.set(&101, || {
    ///         // ...
    ///     });
    ///
    ///     // Recursive calls restore the previous value.
    ///     let val = FOO.with(|v| *v);
    ///     assert_eq!(val, 100);
    /// });
    /// # }
    /// ```
    pub fn set<F, R>(&'static self, t: &T, f: F) -> R
    where
        F: FnOnce() -> R,
    {
        struct Reset<T: ?Sized + 'static> {
            key: &'static LocalKey<Cell<Option<&'static T>>>,
            val: Option<&'static T>,
        }
        impl<T: ?Sized + 'static> Drop for Reset<T> {
            fn drop(&mut self) {
                self.key.with(|c| c.set(self.val));
            }
        }
        let prev = self.inner.with(|c| {
            // Safety: we are only changing the lifetime. We enforce the
            // lifetime constraints via the `Reset` struct.
            c.replace(Some(unsafe { cast_to_static(t) }))
        });
        let _reset = Reset {
            key: self.inner,
            val: prev,
        };
        f()
    }

    /// Gets a value out of this scoped variable.
    ///
    /// This function takes a closure which receives the value of this
    /// variable.
    ///
    /// # Panics
    ///
    /// This function will panic if `set` has not previously been called.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use scoped_tls_hkt::scoped_thread_local;
    ///
    /// scoped_thread_local!(static FOO: u32);
    ///
    /// # fn main() {
    /// FOO.with(|slot| {
    ///     // work with `slot`
    /// # drop(slot);
    /// });
    /// # }
    /// ```
    pub fn with<F, R>(&'static self, f: F) -> R
    where
        F: FnOnce(&T) -> R,
    {
        let val = self
            .inner
            .with(|c| c.get())
            .expect("cannot access a scoped thread local variable without calling `set` first");
        f(cast_from_static(&val))
    }

    /// Test whether this TLS key has been `set` for the current thread.
    pub fn is_set(&'static self) -> bool {
        self.inner.with(|c| c.get().is_some())
    }
}

/// Type representing a thread local storage key corresponding to a mutable reference
/// to the type parameter `T`.
///
/// Keys are statically allocated and can contain a reference to an instance of
/// type `T` scoped to a particular lifetime. Keys provides two methods, `set`
/// and `with`, both of which currently use closures to control the scope of
/// their contents.
///
/// This differs from a `ScopedKey` because it provides access through a mutable
/// reference. As a result, when the `with(..)` method is used to access the value,
/// the key will appear unset whilst the closure is running. This is to prevent
/// the value being borrowed a second time.
pub struct ScopedKeyMut<T: ?Sized + 'static> {
    #[doc(hidden)]
    pub inner: &'static LocalKey<Cell<Option<&'static mut T>>>,
}

unsafe impl<T: ?Sized + 'static> Sync for ScopedKeyMut<T> {}

unsafe fn cast_to_static_mut<T: ?Sized + 'static>(x: &mut T) -> &'static mut T {
    std::mem::transmute(x)
}

// This wrapper helps to ensure that the 'static lifetime is not visible
// to the safe code.
fn cast_from_static_mut<'a, 'b, T: ?Sized + 'static>(x: &'a mut &mut T) -> &'b mut T
where
    'a: 'b,
{
    *x
}

impl<T: ?Sized + 'static> ScopedKeyMut<T> {
    fn replace<F, R>(&'static self, t: Option<&mut T>, f: F) -> R
    where
        F: FnOnce(Option<&mut T>) -> R,
    {
        struct Reset<T: ?Sized + 'static> {
            key: &'static LocalKey<Cell<Option<&'static mut T>>>,
            val: Option<&'static mut T>,
        }
        impl<T: ?Sized + 'static> Drop for Reset<T> {
            fn drop(&mut self) {
                self.key.with(|c| c.set(self.val.take()));
            }
        }
        let prev = self.inner.with(move |c| {
            // Safety: we are only changing the lifetime. We enforce the
            // lifetime constraints via the `Reset` struct.
            c.replace(t.map(|x| unsafe { cast_to_static_mut(x) }))
        });
        let mut reset = Reset {
            key: self.inner,
            val: prev,
        };
        f(reset.val.as_mut().map(cast_from_static_mut))
    }

    /// Inserts a value into this scoped thread local storage slot for a
    /// duration of a closure.
    pub fn set<F, R>(&'static self, t: &mut T, f: F) -> R
    where
        F: FnOnce() -> R,
    {
        self.replace(Some(t), |_| f())
    }

    /// Gets a value out of this scoped variable.
    ///
    /// This function takes a closure which receives the value of this
    /// variable. For the duration of the closure, the key will appear
    /// unset.
    ///
    /// # Panics
    ///
    /// This function will panic if `set` has not previously been called,
    /// or if the call is nested inside another (multiple mutable borrows
    /// of the same value are not allowed).
    ///
    pub fn with<F, R>(&'static self, f: F) -> R
    where
        F: FnOnce(&mut T) -> R,
    {
        self.replace(None, |val| {
            f(val
                .expect("cannot access a scoped thread local variable without calling `set` first"))
        })
    }

    /// Test whether this TLS key has been `set` for the current thread.
    pub fn is_set(&'static self) -> bool {
        self.replace(None, |prev| prev.is_some())
    }
}

#[cfg(test)]
mod tests {
    use std::cell::Cell;
    use std::panic;
    use std::sync::mpsc::{channel, Sender};
    use std::thread;

    scoped_thread_local!(static FOO: u32);

    #[test]
    fn smoke() {
        scoped_thread_local!(static BAR: u32);

        assert!(!BAR.is_set());
        BAR.set(&1, || {
            assert!(BAR.is_set());
            BAR.with(|slot| {
                assert_eq!(*slot, 1);
            });
        });
        assert!(!BAR.is_set());
    }

    #[test]
    fn cell_allowed() {
        scoped_thread_local!(static BAR: Cell<u32>);

        BAR.set(&Cell::new(1), || {
            BAR.with(|slot| {
                assert_eq!(slot.get(), 1);
            });
        });
    }

    #[test]
    fn scope_item_allowed() {
        assert!(!FOO.is_set());
        FOO.set(&1, || {
            assert!(FOO.is_set());
            FOO.with(|slot| {
                assert_eq!(*slot, 1);
            });
        });
        assert!(!FOO.is_set());
    }

    #[test]
    #[cfg_attr(miri, ignore)]
    fn panic_resets() {
        struct Check(Sender<u32>);
        impl Drop for Check {
            fn drop(&mut self) {
                FOO.with(|r| {
                    self.0.send(*r).unwrap();
                })
            }
        }

        let (tx, rx) = channel();

        // Temporarily suppress panic output, as it would interfere
        // with the test harness output.
        let prev_hook = panic::take_hook();
        panic::set_hook(Box::new(|_| {
            // Do nothing
        }));

        let t = thread::spawn(|| {
            FOO.set(&1, || {
                let _r = Check(tx);

                FOO.set(&2, || panic!());
            });
        });

        let res = t.join();
        panic::set_hook(prev_hook);

        assert_eq!(rx.recv().unwrap(), 1);
        assert!(res.is_err());
    }

    #[test]
    fn attrs_allowed() {
        scoped_thread_local!(
            /// Docs
            static BAZ: u32
        );

        scoped_thread_local!(
            #[allow(non_upper_case_globals)]
            static quux: u32
        );

        let _ = BAZ;
        let _ = quux;
    }

    #[test]
    fn hkt_struct() {
        #[derive(Copy, Clone)]
        pub struct Foo<'a> {
            x: &'a str,
            y: &'a i32,
        }
        scoped_thread_local!(static BAR: for<'a> Foo<'a>);

        assert!(!BAR.is_set());
        BAR.set(Foo { x: "hi", y: &1 }, || {
            assert!(BAR.is_set());
            BAR.with(|slot| {
                assert_eq!(slot.x, "hi");
                assert_eq!(slot.y, &1);
            });
        });
        assert!(!BAR.is_set());
    }

    #[test]
    fn hkt_trait() {
        scoped_thread_local!(static BAR: for<'a> &'a dyn std::fmt::Display);

        assert!(!BAR.is_set());
        BAR.set(&"Hello", || {
            assert!(BAR.is_set());
            BAR.with(|slot| {
                assert_eq!(slot.to_string(), "Hello");
            });
            BAR.set(&42, || {
                assert!(BAR.is_set());
                BAR.with(|slot| {
                    assert_eq!(slot.to_string(), "42");
                });
            });
        });
        assert!(!BAR.is_set());
    }

    #[test]
    fn mut_value() {
        scoped_thread_local!(static mut BAR: i32);

        assert!(!BAR.is_set());
        let mut x = 0;

        BAR.set(&mut x, || {
            assert!(BAR.is_set());
            BAR.with(|slot| {
                assert!(!BAR.is_set());
                assert_eq!(*slot, 0);
                *slot = 42;
            });
            let mut y = 2;
            BAR.set(&mut y, || {
                assert!(BAR.is_set());
                BAR.with(|slot| {
                    assert_eq!(*slot, 2);
                    *slot = 15;
                });
            });
            assert_eq!(y, 15);
            assert!(BAR.is_set());
        });
        assert!(!BAR.is_set());
        assert_eq!(x, 42);
    }

    #[test]
    fn mut_trait() {
        scoped_thread_local!(static mut BAR: dyn std::io::Write);

        assert!(!BAR.is_set());
        let mut x = Vec::new();

        BAR.set(&mut x, || {
            assert!(BAR.is_set());
            BAR.with(|slot| {
                slot.write_all(&[1, 2, 3]).unwrap();
            });
        });
        assert!(!BAR.is_set());
        assert_eq!(x, [1, 2, 3]);
    }

    #[test]
    fn hkt_mut_tuple() {
        scoped_thread_local!(static mut BAR: for<'a> (&'a mut i32, &'a mut f32));

        let mut x = 1;
        let mut y = 2.0;

        assert!(!BAR.is_set());
        BAR.set((&mut x, &mut y), || {
            assert!(BAR.is_set());
            BAR.with(|(u, v)| {
                assert_eq!(*u, 1);
                assert_eq!(*v, 2.0);
                assert!(!BAR.is_set());
                *u = 3;
                *v = 4.0;
            });
        });
        assert!(!BAR.is_set());
        assert_eq!(x, 3);
        assert_eq!(y, 4.0);
    }

    #[test]
    fn hkt_mut_trait() {
        scoped_thread_local!(static mut BAR: for<'a> (&'a mut (dyn std::fmt::Display + 'static), &'a mut dyn std::any::Any));

        assert!(!BAR.is_set());
        let mut x = "Hello";
        let mut y = 42;
        BAR.set((&mut x, &mut y), || {
            assert!(BAR.is_set());
            BAR.with(|(u, _)| {
                assert_eq!(u.to_string(), "Hello");
            });
        });
        assert!(!BAR.is_set());
    }

    #[test]
    fn hkt_mut_newtype() {
        struct Foo<'a> {
            x: &'a mut (dyn std::fmt::Display + 'a),
            y: i32,
        }

        impl<'a, 'b> crate::ReborrowMut<'a> for Foo<'b> {
            type Result = Foo<'a>;
            fn reborrow_mut(&'a mut self) -> Self::Result {
                Foo {
                    x: self.x,
                    y: self.y,
                }
            }
        }

        scoped_thread_local!(static mut BAR: for<'a> Foo<'a>);

        assert!(!BAR.is_set());
        let mut x = "Hello";
        BAR.set(Foo { x: &mut x, y: 1 }, || {
            assert!(BAR.is_set());
            BAR.with(|foo| {
                assert_eq!(foo.x.to_string(), "Hello");
            });
        });
        assert!(!BAR.is_set());
    }
}