compiler/rustc_data_structures/src/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/nightly-rustc/")]
  10 #![feature(array_windows)]
  11 #![feature(control_flow_enum)]
  12 #![feature(in_band_lifetimes)]
  13 #![feature(unboxed_closures)]
  14 #![feature(generator_trait)]
  15 #![feature(fn_traits)]
  16 #![feature(int_bits_const)]
  17 #![feature(min_specialization)]
  18 #![feature(optin_builtin_traits)]
  19 #![feature(nll)]
  20 #![feature(allow_internal_unstable)]
  21 #![feature(hash_raw_entry)]
  22 #![feature(stmt_expr_attributes)]
  23 #![feature(core_intrinsics)]
  24 #![feature(test)]
  25 #![feature(associated_type_bounds)]
  26 #![feature(thread_id_value)]
  27 #![feature(extend_one)]
  28 #![feature(const_panic)]
  29 #![feature(min_const_generics)]
  30 #![feature(once_cell)]
  31 #![feature(maybe_uninit_uninit_array)]
  32 #![allow(rustc::default_hash_types)]
  33
  34 #[macro_use]
  35 extern crate tracing;
  36 #[macro_use]
  37 extern crate cfg_if;
  38 #[macro_use]
  39 extern crate rustc_macros;
  40
  41 #[inline(never)]
  42 #[cold]
  43 pub fn cold_path<F: FnOnce() -> R, R>(f: F) -> R {
  44     f()
  45 }
  46
  47 #[macro_export]
  48 macro_rules! likely {
  49     ($e:expr) => {
  50         #[allow(unused_unsafe)]
  51         {
  52             unsafe { std::intrinsics::likely($e) }
  53         }
  54     };
  55 }
  56
  57 #[macro_export]
  58 macro_rules! unlikely {
  59     ($e:expr) => {
  60         #[allow(unused_unsafe)]
  61         {
  62             unsafe { std::intrinsics::unlikely($e) }
  63         }
  64     };
  65 }
  66
  67 pub mod base_n;
  68 pub mod binary_search_util;
  69 pub mod box_region;
  70 pub mod captures;
  71 pub mod const_cstr;
  72 pub mod flock;
  73 pub mod fx;
  74 pub mod graph;
  75 pub mod jobserver;
  76 pub mod macros;
  77 pub mod map_in_place;
  78 pub mod obligation_forest;
  79 pub mod owning_ref;
  80 pub mod ptr_key;
  81 pub mod sip128;
  82 pub mod small_c_str;
  83 pub mod snapshot_map;
  84 pub mod stable_map;
  85 pub mod svh;
  86 pub use ena::snapshot_vec;
  87 pub mod sorted_map;
  88 pub mod stable_set;
  89 #[macro_use]
  90 pub mod stable_hasher;
  91 mod atomic_ref;
  92 pub mod fingerprint;
  93 pub mod profiling;
  94 pub mod sharded;
  95 pub mod stack;
  96 pub mod sync;
  97 pub mod thin_vec;
  98 pub mod tiny_list;
  99 pub mod transitive_relation;
 100 pub mod vec_linked_list;
 101 pub mod work_queue;
 102 pub use atomic_ref::AtomicRef;
 103 pub mod frozen;
 104 pub mod mini_map;
 105 pub mod mini_set;
 106 pub mod tagged_ptr;
 107 pub mod temp_dir;
 108 pub mod unhash;
 109
 110 pub use ena::undo_log;
 111 pub use ena::unify;
 112
 113 pub struct OnDrop<F: Fn()>(pub F);
 114
 115 impl<F: Fn()> OnDrop<F> {
 116     /// Forgets the function which prevents it from running.
 117     /// Ensure that the function owns no memory, otherwise it will be leaked.
 118     #[inline]
 119     pub fn disable(self) {
 120         std::mem::forget(self);
 121     }
 122 }
 123
 124 impl<F: Fn()> Drop for OnDrop<F> {
 125     #[inline]
 126     fn drop(&mut self) {
 127         (self.0)();
 128     }
 129 }
 130
 131 // See comments in src/librustc_middle/lib.rs
 132 #[doc(hidden)]
 133 pub fn __noop_fix_for_27438() {}