      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

    /*!
    A macro for declaring lazily evaluated statics.

    Using this macro, it is possible to have `static`s that require code to be
    executed at runtime in order to be initialized.
    This includes anything requiring heap allocations, like vectors or hash maps,
    as well as anything that requires function calls to be computed.

    # Syntax

    ```ignore
    lazy_static! {
        [pub] static ref NAME_1: TYPE_1 = EXPR_1;
        [pub] static ref NAME_2: TYPE_2 = EXPR_2;
        ...
        [pub] static ref NAME_N: TYPE_N = EXPR_N;
    }
    ```

    Metadata (such as doc comments) is allowed on each ref.

    # Semantic

    For a given `static ref NAME: TYPE = EXPR;`, the macro generates a unique type that
    implements `Deref<TYPE>` and stores it in a static with name `NAME`. (Metadata ends up
    attaching to this type.)

    On first deref, `EXPR` gets evaluated and stored internally, such that all further derefs
    can return a reference to the same object.

    Like regular `static mut`s, this macro only works for types that fulfill the `Sync`
    trait.

    # Example

    Using the macro:

    ```rust
    #[macro_use]
    extern crate lazy_static;

    use std::collections::HashMap;

    lazy_static! {
        static ref HASHMAP: HashMap<u32, &'static str> = {
            let mut m = HashMap::new();
            m.insert(0, "foo");
            m.insert(1, "bar");
            m.insert(2, "baz");
            m
        };
        static ref COUNT: usize = HASHMAP.len();
        static ref NUMBER: u32 = times_two(21);
    }

    fn times_two(n: u32) -> u32 { n * 2 }

    fn main() {
        println!("The map has {} entries.", *COUNT);
        println!("The entry for `0` is \"{}\".", HASHMAP.get(&0).unwrap());
        println!("A expensive calculation on a static results in: {}.", *NUMBER);
    }
    ```

    # Implementation details

    The `Deref` implementation uses a hidden static variable that is guarded by a atomic check on each access. On stable Rust, the macro may need to allocate each static on the heap.

    */

    #![cfg_attr(feature="nightly", feature(const_fn, core_intrinsics))]
    #![crate_type = "dylib"]

    #[macro_export]
    macro_rules! lazy_static {
        ($(#[$attr:meta])* static ref $N:ident : $T:ty = $e:expr; $($t:tt)*) => {
            lazy_static!(PRIV, $(#[$attr])* static ref $N : $T = $e; $($t)*);
        };
        ($(#[$attr:meta])* pub static ref $N:ident : $T:ty = $e:expr; $($t:tt)*) => {
            lazy_static!(PUB, $(#[$attr])* static ref $N : $T = $e; $($t)*);
        };
        ($VIS:ident, $(#[$attr:meta])* static ref $N:ident : $T:ty = $e:expr; $($t:tt)*) => {
            lazy_static!(MAKE TY, $VIS, $(#[$attr])*, $N);
            impl ::std::ops::Deref for $N {
                type Target = $T;
                fn deref<'a>(&'a self) -> &'a $T {
                    #[inline(always)]
                    fn __static_ref_initialize() -> $T { $e }

                    unsafe {
                        use std::sync::{Once, ONCE_INIT};

                        #[inline(always)]
                        fn require_sync<T: Sync>(_: &T) { }

                        #[inline(always)]
                        #[cfg(feature="nightly")]
                        unsafe fn __stability() -> &'static $T {
                            use std::cell::UnsafeCell;

                            struct SyncCell(UnsafeCell<Option<$T>>);
                            unsafe impl Sync for SyncCell {}

                            static DATA: SyncCell = SyncCell(UnsafeCell::new(None));
                            static ONCE: Once = ONCE_INIT;
                            ONCE.call_once(|| {
                                *DATA.0.get() = Some(__static_ref_initialize());
                            });
                            match *DATA.0.get() {
                                Some(ref x) => x,
                                None => ::std::intrinsics::unreachable(),
                            }
                        }

                        #[inline(always)]
                        #[cfg(not(feature="nightly"))]
                        unsafe fn __stability() -> &'static $T {
                            use std::mem::transmute;
                            use std::boxed::Box;

                            static mut DATA: *const $T = 0 as *const $T;
                            static mut ONCE: Once = ONCE_INIT;
                            ONCE.call_once(|| {
                                DATA = transmute::<Box<$T>, *const $T>(
                                    Box::new(__static_ref_initialize()));
                            });
                            &*DATA
                        }

                        let static_ref = __stability();
                        require_sync(static_ref);
                        static_ref
                    }
                }
            }
            lazy_static!($($t)*);
        };
        (MAKE TY, PUB, $(#[$attr:meta])*, $N:ident) => {
            #[allow(missing_copy_implementations)]
            #[allow(non_camel_case_types)]
            #[allow(dead_code)]
            $(#[$attr])*
            pub struct $N {__private_field: ()}
            #[doc(hidden)]
            pub static $N: $N = $N {__private_field: ()};
        };
        (MAKE TY, PRIV, $(#[$attr:meta])*, $N:ident) => {
            #[allow(missing_copy_implementations)]
            #[allow(non_camel_case_types)]
            #[allow(dead_code)]
            $(#[$attr])*
            struct $N {__private_field: ()}
            #[doc(hidden)]
            static $N: $N = $N {__private_field: ()};
        };
        () => ()
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)