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