]> git.lizzy.rs Git - rust.git/blob - src/librustc_data_structures/lib.rs
pin docs: add some forward references
[rust.git] / src / librustc_data_structures / lib.rs
1 //! Various data structures used by the Rust compiler. The intention
2 //! is that code in here should be not be *specific* to rustc, so that
3 //! it can be easily unit tested and so forth.
4 //!
5 //! # Note
6 //!
7 //! This API is completely unstable and subject to change.
8
9 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
10 #![feature(in_band_lifetimes)]
11 #![feature(unboxed_closures)]
12 #![feature(generators)]
13 #![feature(generator_trait)]
14 #![feature(fn_traits)]
15 #![feature(min_specialization)]
16 #![feature(optin_builtin_traits)]
17 #![feature(nll)]
18 #![feature(allow_internal_unstable)]
19 #![feature(hash_raw_entry)]
20 #![feature(stmt_expr_attributes)]
21 #![feature(core_intrinsics)]
22 #![feature(test)]
23 #![feature(associated_type_bounds)]
24 #![feature(thread_id_value)]
25 #![feature(extend_one)]
26 #![allow(rustc::default_hash_types)]
27
28 #[macro_use]
29 extern crate log;
30 #[macro_use]
31 extern crate cfg_if;
32
33 #[inline(never)]
34 #[cold]
35 pub fn cold_path<F: FnOnce() -> R, R>(f: F) -> R {
36     f()
37 }
38
39 #[macro_export]
40 macro_rules! likely {
41     ($e:expr) => {
42         #[allow(unused_unsafe)]
43         {
44             unsafe { std::intrinsics::likely($e) }
45         }
46     };
47 }
48
49 #[macro_export]
50 macro_rules! unlikely {
51     ($e:expr) => {
52         #[allow(unused_unsafe)]
53         {
54             unsafe { std::intrinsics::unlikely($e) }
55         }
56     };
57 }
58
59 pub mod base_n;
60 pub mod binary_search_util;
61 pub mod box_region;
62 pub mod captures;
63 pub mod const_cstr;
64 pub mod flock;
65 pub mod fx;
66 pub mod graph;
67 pub mod jobserver;
68 pub mod macros;
69 pub mod map_in_place;
70 pub mod obligation_forest;
71 pub mod owning_ref;
72 pub mod ptr_key;
73 pub mod sip128;
74 pub mod small_c_str;
75 pub mod snapshot_map;
76 pub mod stable_map;
77 pub mod svh;
78 pub use ena::snapshot_vec;
79 pub mod sorted_map;
80 pub mod stable_set;
81 #[macro_use]
82 pub mod stable_hasher;
83 pub mod sharded;
84 pub mod stack;
85 pub mod sync;
86 pub mod thin_vec;
87 pub mod tiny_list;
88 pub mod transitive_relation;
89 pub use ena::undo_log;
90 pub use ena::unify;
91 mod atomic_ref;
92 pub mod fingerprint;
93 pub mod profiling;
94 pub mod vec_linked_list;
95 pub mod work_queue;
96 pub use atomic_ref::AtomicRef;
97 pub mod frozen;
98 pub mod temp_dir;
99
100 pub struct OnDrop<F: Fn()>(pub F);
101
102 impl<F: Fn()> OnDrop<F> {
103     /// Forgets the function which prevents it from running.
104     /// Ensure that the function owns no memory, otherwise it will be leaked.
105     #[inline]
106     pub fn disable(self) {
107         std::mem::forget(self);
108     }
109 }
110
111 impl<F: Fn()> Drop for OnDrop<F> {
112     #[inline]
113     fn drop(&mut self) {
114         (self.0)();
115     }
116 }
117
118 // See comments in src/librustc_middle/lib.rs
119 #[doc(hidden)]
120 pub fn __noop_fix_for_27438() {}