lazy.rs.html -- source
Description: Source to the Rust file `src/libstd/io/lazy.rs`.
Keywords: rust, rustlang, rust-lang

     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

    use cell::Cell;
    use ptr;
    use sync::Arc;
    use sys_common;
    use sys_common::mutex::Mutex;

    pub struct Lazy<T> {
        // We never call `lock.init()`, so it is UB to attempt to acquire this mutex reentrantly!
        lock: Mutex,
        ptr: Cell<*mut Arc<T>>,
    }

    #[inline]
    const fn done<T>() -> *mut Arc<T> { 1_usize as *mut _ }

    unsafe impl<T> Sync for Lazy<T> {}

    impl<T> Lazy<T> {
        pub const fn new() -> Lazy<T> {
            Lazy {
                lock: Mutex::new(),
                ptr: Cell::new(ptr::null_mut()),
            }
        }
    }

    impl<T: Send + Sync + 'static> Lazy<T> {
        /// Safety: `init` must not call `get` on the variable that is being
        /// initialized.
        pub unsafe fn get(&'static self, init: fn() -> Arc<T>) -> Option<Arc<T>> {
            let _guard = self.lock.lock();
            let ptr = self.ptr.get();
            if ptr.is_null() {
                Some(self.init(init))
            } else if ptr == done() {
                None
            } else {
                Some((*ptr).clone())
            }
        }

        // Must only be called with `lock` held
        unsafe fn init(&'static self, init: fn() -> Arc<T>) -> Arc<T> {
            // If we successfully register an at exit handler, then we cache the
            // `Arc` allocation in our own internal box (it will get deallocated by
            // the at exit handler). Otherwise we just return the freshly allocated
            // `Arc`.
            let registered = sys_common::at_exit(move || {
                let ptr = {
                    let _guard = self.lock.lock();
                    self.ptr.replace(done())
                };
                drop(Box::from_raw(ptr))
            });
            // This could reentrantly call `init` again, which is a problem
            // because our `lock` allows reentrancy!
            // That's why `get` is unsafe and requires the caller to ensure no reentrancy happens.
            let ret = init();
            if registered.is_ok() {
                self.ptr.set(Box::into_raw(Box::new(ret.clone())));
            }
            ret
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## 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`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)