+/livesplit-wrapper
git clone https://git.julia.blue/+/livesplit-wrapper
b0170e4
gh-pages
1<!DOCTYPE html >< html lang ="en ">< head >< meta charset ="utf-8 ">< meta name ="viewport "content ="width=device-width, initial-scale=1.0 ">< meta name ="generator "content ="rustdoc ">< meta name ="description "content ="A thread-safe cell which can be written to only once. ">< meta name ="keywords "content ="rust, rustlang, rust-lang, OnceCell ">< title > OnceCell in once_cell::sync - Rust</ title >< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../SourceSerif4-Regular.ttf.woff2 ">< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../FiraSans-Regular.woff2 ">< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../FiraSans-Medium.woff2 ">< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../SourceCodePro-Regular.ttf.woff2 ">< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../SourceSerif4-Bold.ttf.woff2 ">< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../SourceCodePro-Semibold.ttf.woff2 ">< link rel ="stylesheet "href ="../../normalize.css ">< link rel ="stylesheet "href ="../../rustdoc.css "id ="mainThemeStyle ">< link rel ="stylesheet "href ="../../ayu.css "disabled >< link rel ="stylesheet "href ="../../dark.css "disabled >< link rel ="stylesheet "href ="../../light.css "id ="themeStyle ">< script id ="default-settings "></ script >< script src ="../../storage.js "></ script >< script defer src ="sidebar-items.js "></ script >< script defer src ="../../main.js "></ script >< noscript >< link rel ="stylesheet "href ="../../noscript.css "></ noscript >< link rel ="alternate icon "type ="image/png "href ="../../favicon-16x16.png ">< link rel ="alternate icon "type ="image/png "href ="../../favicon-32x32.png ">< link rel ="icon "type ="image/svg+xml "href ="../../favicon.svg "></ head >< body class ="rustdoc struct "> <!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--> < nav class ="mobile-topbar ">< button class ="sidebar-menu-toggle "> ☰</ button >< a class ="sidebar-logo "href ="../../once_cell/index.html ">< div class ="logo-container ">< img class ="rust-logo "src ="../../rust-logo.svg "alt ="logo "></ div ></ a >< h2 class ="location "></ h2 ></ nav >< nav class ="sidebar ">< a class ="sidebar-logo "href ="../../once_cell/index.html ">< div class ="logo-container ">< img class ="rust-logo "src ="../../rust-logo.svg "alt ="logo "></ div ></ a >< h2 class ="location ">< a href ="# "> OnceCell</ a ></ h2 >< div class ="sidebar-elems ">< section >< div class ="block ">< h3 class ="sidebar-title ">< a href ="#implementations "> Methods</ a ></ h3 >< ul >< li >< a href ="#method.get "> get</ a ></ li >< li >< a href ="#method.get_mut "> get_mut</ a ></ li >< li >< a href ="#method.get_or_init "> get_or_init</ a ></ li >< li >< a href ="#method.get_or_try_init "> get_or_try_init</ a ></ li >< li >< a href ="#method.get_unchecked "> get_unchecked</ a ></ li >< li >< a href ="#method.into_inner "> into_inner</ a ></ li >< li >< a href ="#method.new "> new</ a ></ li >< li >< a href ="#method.set "> set</ a ></ li >< li >< a href ="#method.take "> take</ a ></ li >< li >< a href ="#method.try_insert "> try_insert</ a ></ li >< li >< a href ="#method.wait "> wait</ a ></ li >< li >< a href ="#method.with_value "> with_value</ a ></ li ></ ul ></ div >< div class ="block ">< h3 class ="sidebar-title ">< a href ="#trait-implementations "> Trait Implementations</ a ></ h3 >< ul >< li >< a href ="#impl-Clone-for-OnceCell%3CT%3E "> Clone</ a ></ li >< li >< a href ="#impl-Debug-for-OnceCell%3CT%3E "> Debug</ a ></ li >< li >< a href ="#impl-Default-for-OnceCell%3CT%3E "> Default</ a ></ li >< li >< a href ="#impl-Eq-for-OnceCell%3CT%3E "> Eq</ a ></ li >< li >< a href ="#impl-From%3CT%3E-for-OnceCell%3CT%3E "> From<T></ a ></ li >< li >< a href ="#impl-PartialEq%3COnceCell%3CT%3E%3E-for-OnceCell%3CT%3E "> PartialEq<OnceCell<T>></ a ></ li ></ ul ></ div >< div class ="block ">< h3 class ="sidebar-title ">< a href ="#synthetic-implementations "> Auto Trait Implementations</ a ></ h3 >< ul >< li >< a href ="#impl-RefUnwindSafe-for-OnceCell%3CT%3E "> RefUnwindSafe</ a ></ li >< li >< a href ="#impl-Send-for-OnceCell%3CT%3E "> Send</ a ></ li >< li >< a href ="#impl-Sync-for-OnceCell%3CT%3E "> Sync</ a ></ li >< li >< a href ="#impl-Unpin-for-OnceCell%3CT%3E "> Unpin</ a ></ li >< li >< a href ="#impl-UnwindSafe-for-OnceCell%3CT%3E "> UnwindSafe</ a ></ li ></ ul ></ div >< div class ="block ">< h3 class ="sidebar-title ">< a href ="#blanket-implementations "> Blanket Implementations</ a ></ h3 >< ul >< li >< a href ="#impl-Any-for-OnceCell%3CT%3E "> Any</ a ></ li >< li >< a href ="#impl-Borrow%3CT%3E-for-OnceCell%3CT%3E "> Borrow<T></ a ></ li >< li >< a href ="#impl-BorrowMut%3CT%3E-for-OnceCell%3CT%3E "> BorrowMut<T></ a ></ li >< li >< a href ="#impl-From%3C!%3E-for-OnceCell%3CT%3E "> From<!></ a ></ li >< li >< a href ="#impl-From%3CT%3E-for-OnceCell%3CT%3E-1 "> From<T></ a ></ li >< li >< a href ="#impl-Into%3CU%3E-for-OnceCell%3CT%3E "> Into<U></ a ></ li >< li >< a href ="#impl-ToOwned-for-OnceCell%3CT%3E "> ToOwned</ a ></ li >< li >< a href ="#impl-TryFrom%3CU%3E-for-OnceCell%3CT%3E "> TryFrom<U></ a ></ li >< li >< a href ="#impl-TryInto%3CU%3E-for-OnceCell%3CT%3E "> TryInto<U></ a ></ li ></ ul ></ div ></ section >< h2 class ="location ">< a href ="index.html "> In once_cell::sync</ a ></ h2 ></ div ></ nav >< main >< div class ="width-limiter ">< div class ="sub-container ">< a class ="sub-logo-container "href ="../../once_cell/index.html ">< img class ="rust-logo "src ="../../rust-logo.svg "alt ="logo "></ a >< nav class ="sub ">< form class ="search-form ">< div class ="search-container ">< span ></ span >< input class ="search-input "name ="search "autocomplete ="off "spellcheck ="false "placeholder ="Click or press ‘S’ to search, ‘?’ for more options… "type ="search ">< div id ="help-button "title ="help "tabindex ="-1 ">< button type ="button "> ?</ button ></ div >< div id ="settings-menu "tabindex ="-1 ">< a href ="../../settings.html "title ="settings ">< img width ="22 "height ="22 "alt ="Change settings "src ="../../wheel.svg "></ a ></ div ></ div ></ form ></ nav ></ div >< section id ="main-content "class ="content ">< div class ="main-heading ">< h1 class ="fqn ">< span class ="in-band "> Struct< a href ="../index.html "> once_cell</ a > ::< wbr >< a href ="index.html "> sync</ a > ::< wbr >< a class ="struct "href ="# "> OnceCell</ a >< button id ="copy-path "onclick ="copy_path(this) "title ="Copy item path to clipboard ">< img src ="../../clipboard.svg "width ="19 "height ="18 "alt ="Copy item path "></ button ></ span ></ h1 >< span class ="out-of-band ">< a class ="srclink "href ="../../src/once_cell/lib.rs.html#856 "> source</ a > ·< a id ="toggle-all-docs "href ="javascript:void(0) "title ="collapse all docs "> [< span class ="inner "> −</ span > ]</ a ></ span ></ div >< div class ="item-decl ">< pre class ="rust struct ">< code > pub struct OnceCell<T>(_);</ code ></ pre ></ div >< details class ="rustdoc-toggle top-doc "open >< summary class ="hideme ">< span > Expand description</ span ></ summary >< div class ="docblock ">< p > A thread-safe cell which can be written to only once.</ p > 2< p >< code > OnceCell</ code > provides< code > &</ code > references to the contents without RAII guards.</ p > 3< p > Reading a non-< code > None</ code > value out of< code > OnceCell</ code > establishes a 4happens-before relationship with a corresponding write. For example, if 5thread A initializes the cell with< code > get_or_init(f)</ code > , and thread B 6subsequently reads the result of this call, B also observes all the side 7effects of< code > f</ code > .</ p > 8< h2 id ="example ">< a href ="#example "> Example</ a ></ h2 > 9< div class ="example-wrap ">< pre class ="rust rust-example-rendered ">< code >< span class ="kw "> use</ span > once_cell::sync::OnceCell; 10 11< span class ="kw "> static</ span > CELL: OnceCell<String> = OnceCell::new(); 12< span class ="macro "> assert!</ span > (CELL.get().is_none()); 13 14std::thread::spawn(|| { 15< span class ="kw "> let</ span > value:< span class ="kw-2 "> &</ span > String = CELL.get_or_init(|| { 16< span class ="string "> "Hello, World!"</ span > .to_string() 17 }); 18< span class ="macro "> assert_eq!</ span > (value,< span class ="string "> "Hello, World!"</ span > ); 19}).join().unwrap(); 20 21< span class ="kw "> let</ span > value:< span class ="prelude-ty "> Option</ span > << span class ="kw-2 "> &</ span > String> = CELL.get(); 22< span class ="macro "> assert!</ span > (value.is_some()); 23< span class ="macro "> assert_eq!</ span > (value.unwrap().as_str(),< span class ="string "> "Hello, World!"</ span > );</ code ></ pre ></ div > 24</ div ></ details >< h2 id ="implementations "class ="small-section-header "> Implementations< a href ="#implementations "class ="anchor "></ a ></ h2 >< div id ="implementations-list ">< details class ="rustdoc-toggle implementors-toggle "open >< summary >< section id ="impl-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#903-1170 "> source</ a >< a href ="#impl-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.new "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#905-907 "> source</ a >< h4 class ="code-header "> pub const fn< a href ="#method.new "class ="fnname "> new</ a > () ->< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h4 ></ section ></ summary >< div class ="docblock ">< p > Creates a new empty cell.</ p > 25</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.with_value "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#910-912 "> source</ a >< h4 class ="code-header "> pub const fn< a href ="#method.with_value "class ="fnname "> with_value</ a > (value: T) ->< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h4 ></ section ></ summary >< div class ="docblock ">< p > Creates a new initialized cell.</ p > 26</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.get "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#918-925 "> source</ a >< h4 class ="code-header "> pub fn< a href ="#method.get "class ="fnname "> get</ a > (&self) ->< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/option/enum.Option.html "title ="enum core::option::Option "> Option</ a > << a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &</ a > T></ h4 ></ section ></ summary >< div class ="docblock ">< p > Gets the reference to the underlying value.</ p > 27< p > Returns< code > None</ code > if the cell is empty, or being initialized. This 28method never blocks.</ p > 29</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.wait "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#947-955 "> source</ a >< h4 class ="code-header "> pub fn< a href ="#method.wait "class ="fnname "> wait</ a > (&self) ->< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &</ a > T</ h4 ></ section ></ summary >< div class ="docblock ">< p > Gets the reference to the underlying value, blocking the current 30thread until it is set.</ p > 31 32< div class ="example-wrap ">< pre class ="rust rust-example-rendered ">< code >< span class ="kw "> use</ span > once_cell::sync::OnceCell; 33 34< span class ="kw "> let</ span >< span class ="kw-2 "> mut</ span > cell = std::sync::Arc::new(OnceCell::new()); 35< span class ="kw "> let</ span > t = std::thread::spawn({ 36< span class ="kw "> let</ span > cell = std::sync::Arc::clone(< span class ="kw-2 "> &</ span > cell); 37< span class ="kw "> move</ span > || cell.set(< span class ="number "> 92</ span > ).unwrap() 38}); 39 40< span class ="comment "> // Returns immediately, but might return None. 41</ span >< span class ="kw "> let</ span > _value_or_none = cell.get(); 42 43< span class ="comment "> // Will return 92, but might block until the other thread does `.set`. 44</ span >< span class ="kw "> let</ span > value:< span class ="kw-2 "> &</ span > u32 = cell.wait(); 45< span class ="macro "> assert_eq!</ span > (< span class ="kw-2 "> *</ span > value,< span class ="number "> 92</ span > ); 46t.join().unwrap();;</ code ></ pre ></ div > 47</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.get_mut "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#972-974 "> source</ a >< h4 class ="code-header "> pub fn< a href ="#method.get_mut "class ="fnname "> get_mut</ a > (&mut self) ->< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/option/enum.Option.html "title ="enum core::option::Option "> Option</ a > << a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &mut</ a > T></ h4 ></ section ></ summary >< div class ="docblock ">< p > Gets the mutable reference to the underlying value.</ p > 48< p > Returns< code > None</ code > if the cell is empty.</ p > 49< p > This method is allowed to violate the invariant of writing to a< code > OnceCell</ code > 50at most once because it requires< code > &mut</ code > access to< code > self</ code > . As with all 51interior mutability,< code > &mut</ code > access permits arbitrary modification:</ p > 52 53< div class ="example-wrap ">< pre class ="rust rust-example-rendered ">< code >< span class ="kw "> use</ span > once_cell::sync::OnceCell; 54 55< span class ="kw "> let</ span >< span class ="kw-2 "> mut</ span > cell: OnceCell<u32> = OnceCell::new(); 56cell.set(< span class ="number "> 92</ span > ).unwrap(); 57cell = OnceCell::new();</ code ></ pre ></ div > 58</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.get_unchecked "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#983-985 "> source</ a >< h4 class ="code-header "> pub unsafe fn< a href ="#method.get_unchecked "class ="fnname "> get_unchecked</ a > (&self) ->< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &</ a > T</ h4 ></ section ></ summary >< div class ="docblock ">< p > Get the reference to the underlying value, without checking if the 59cell is initialized.</ p > 60< h5 id ="safety ">< a href ="#safety "> Safety</ a ></ h5 > 61< p > Caller must ensure that the cell is in initialized state, and that 62the contents are acquired by (synchronized to) this thread.</ p > 63</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.set "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#1010-1015 "> source</ a >< h4 class ="code-header "> pub fn< a href ="#method.set "class ="fnname "> set</ a > (&self, value: T) ->< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/result/enum.Result.html "title ="enum core::result::Result "> Result</ a > << a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.unit.html "> ()</ a > , T></ h4 ></ section ></ summary >< div class ="docblock ">< p > Sets the contents of this cell to< code > value</ code > .</ p > 64< p > Returns< code > Ok(())</ code > if the cell was empty and< code > Err(value)</ code > if it was 65full.</ p > 66< h5 id ="example-1 ">< a href ="#example-1 "> Example</ a ></ h5 > 67< div class ="example-wrap ">< pre class ="rust rust-example-rendered ">< code >< span class ="kw "> use</ span > once_cell::sync::OnceCell; 68 69< span class ="kw "> static</ span > CELL: OnceCell<i32> = OnceCell::new(); 70 71< span class ="kw "> fn</ span > main() { 72< span class ="macro "> assert!</ span > (CELL.get().is_none()); 73 74 std::thread::spawn(|| { 75< span class ="macro "> assert_eq!</ span > (CELL.set(< span class ="number "> 92</ span > ),< span class ="prelude-val "> Ok</ span > (())); 76 }).join().unwrap(); 77 78< span class ="macro "> assert_eq!</ span > (CELL.set(< span class ="number "> 62</ span > ),< span class ="prelude-val "> Err</ span > (< span class ="number "> 62</ span > )); 79< span class ="macro "> assert_eq!</ span > (CELL.get(),< span class ="prelude-val "> Some</ span > (< span class ="kw-2 "> &</ span >< span class ="number "> 92</ span > )); 80}</ code ></ pre ></ div > 81</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.try_insert "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#1032-1039 "> source</ a >< h4 class ="code-header "> pub fn< a href ="#method.try_insert "class ="fnname "> try_insert</ a > (&self, value: T) ->< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/result/enum.Result.html "title ="enum core::result::Result "> Result</ a > << a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &</ a > T, (< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &</ a > T, T)></ h4 ></ section ></ summary >< div class ="docblock ">< p > Like< a href ="struct.OnceCell.html#method.set ">< code > set</ code ></ a > , but also returns a reference to the final cell value.</ p > 82< h5 id ="example-2 ">< a href ="#example-2 "> Example</ a ></ h5 > 83< div class ="example-wrap ">< pre class ="rust rust-example-rendered ">< code >< span class ="kw "> use</ span > once_cell::unsync::OnceCell; 84 85< span class ="kw "> let</ span > cell = OnceCell::new(); 86< span class ="macro "> assert!</ span > (cell.get().is_none()); 87 88< span class ="macro "> assert_eq!</ span > (cell.try_insert(< span class ="number "> 92</ span > ),< span class ="prelude-val "> Ok</ span > (< span class ="kw-2 "> &</ span >< span class ="number "> 92</ span > )); 89< span class ="macro "> assert_eq!</ span > (cell.try_insert(< span class ="number "> 62</ span > ),< span class ="prelude-val "> Err</ span > ((< span class ="kw-2 "> &</ span >< span class ="number "> 92</ span > ,< span class ="number "> 62</ span > ))); 90 91< span class ="macro "> assert!</ span > (cell.get().is_some());</ code ></ pre ></ div > 92</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.get_or_init "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#1067-1076 "> source</ a >< h4 class ="code-header "> pub fn< a href ="#method.get_or_init "class ="fnname "> get_or_init</ a > <F>(&self, f: F) ->< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &</ a > T< span class ="where fmt-newline "> where< br > F:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html "title ="trait core::ops::function::FnOnce "> FnOnce</ a > () -> T,</ span ></ h4 ></ section ></ summary >< div class ="docblock ">< p > Gets the contents of the cell, initializing it with< code > f</ code > if the cell 93was empty.</ p > 94< p > Many threads may call< code > get_or_init</ code > concurrently with different 95initializing functions, but it is guaranteed that only one function 96will be executed.</ p > 97< h5 id ="panics ">< a href ="#panics "> Panics</ a ></ h5 > 98< p > If< code > f</ code > panics, the panic is propagated to the caller, and the cell 99remains uninitialized.</ p > 100< p > It is an error to reentrantly initialize the cell from< code > f</ code > . The 101exact outcome is unspecified. Current implementation deadlocks, but 102this may be changed to a panic in the future.</ p > 103< h5 id ="example-3 ">< a href ="#example-3 "> Example</ a ></ h5 > 104< div class ="example-wrap ">< pre class ="rust rust-example-rendered ">< code >< span class ="kw "> use</ span > once_cell::sync::OnceCell; 105 106< span class ="kw "> let</ span > cell = OnceCell::new(); 107< span class ="kw "> let</ span > value = cell.get_or_init(||< span class ="number "> 92</ span > ); 108< span class ="macro "> assert_eq!</ span > (value,< span class ="kw-2 "> &</ span >< span class ="number "> 92</ span > ); 109< span class ="kw "> let</ span > value = cell.get_or_init(||< span class ="macro "> unreachable!</ span > ()); 110< span class ="macro "> assert_eq!</ span > (value,< span class ="kw-2 "> &</ span >< span class ="number "> 92</ span > );</ code ></ pre ></ div > 111</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.get_or_try_init "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#1104-1117 "> source</ a >< h4 class ="code-header "> pub fn< a href ="#method.get_or_try_init "class ="fnname "> get_or_try_init</ a > <F, E>(&self, f: F) ->< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/result/enum.Result.html "title ="enum core::result::Result "> Result</ a > << a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &</ a > T, E>< span class ="where fmt-newline "> where< br > F:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html "title ="trait core::ops::function::FnOnce "> FnOnce</ a > () ->< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/result/enum.Result.html "title ="enum core::result::Result "> Result</ a > <T, E>,</ span ></ h4 ></ section ></ summary >< div class ="docblock ">< p > Gets the contents of the cell, initializing it with< code > f</ code > if 112the cell was empty. If the cell was empty and< code > f</ code > failed, an 113error is returned.</ p > 114< h5 id ="panics-1 ">< a href ="#panics-1 "> Panics</ a ></ h5 > 115< p > If< code > f</ code > panics, the panic is propagated to the caller, and 116the cell remains uninitialized.</ p > 117< p > It is an error to reentrantly initialize the cell from< code > f</ code > . 118The exact outcome is unspecified. Current implementation 119deadlocks, but this may be changed to a panic in the future.</ p > 120< h5 id ="example-4 ">< a href ="#example-4 "> Example</ a ></ h5 > 121< div class ="example-wrap ">< pre class ="rust rust-example-rendered ">< code >< span class ="kw "> use</ span > once_cell::sync::OnceCell; 122 123< span class ="kw "> let</ span > cell = OnceCell::new(); 124< span class ="macro "> assert_eq!</ span > (cell.get_or_try_init(||< span class ="prelude-val "> Err</ span > (())),< span class ="prelude-val "> Err</ span > (())); 125< span class ="macro "> assert!</ span > (cell.get().is_none()); 126< span class ="kw "> let</ span > value = cell.get_or_try_init(|| ->< span class ="prelude-ty "> Result</ span > <i32, ()> { 127< span class ="prelude-val "> Ok</ span > (< span class ="number "> 92</ span > ) 128}); 129< span class ="macro "> assert_eq!</ span > (value,< span class ="prelude-val "> Ok</ span > (< span class ="kw-2 "> &</ span >< span class ="number "> 92</ span > )); 130< span class ="macro "> assert_eq!</ span > (cell.get(),< span class ="prelude-val "> Some</ span > (< span class ="kw-2 "> &</ span >< span class ="number "> 92</ span > ))</ code ></ pre ></ div > 131</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.take "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#1148-1150 "> source</ a >< h4 class ="code-header "> pub fn< a href ="#method.take "class ="fnname "> take</ a > (&mut self) ->< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/option/enum.Option.html "title ="enum core::option::Option "> Option</ a > <T></ h4 ></ section ></ summary >< div class ="docblock ">< p > Takes the value out of this< code > OnceCell</ code > , moving it back to an uninitialized state.</ p > 132< p > Has no effect and returns< code > None</ code > if the< code > OnceCell</ code > hasn’t been initialized.</ p > 133< h5 id ="examples ">< a href ="#examples "> Examples</ a ></ h5 > 134< div class ="example-wrap ">< pre class ="rust rust-example-rendered ">< code >< span class ="kw "> use</ span > once_cell::sync::OnceCell; 135 136< span class ="kw "> let</ span >< span class ="kw-2 "> mut</ span > cell: OnceCell<String> = OnceCell::new(); 137< span class ="macro "> assert_eq!</ span > (cell.take(),< span class ="prelude-val "> None</ span > ); 138 139< span class ="kw "> let</ span >< span class ="kw-2 "> mut</ span > cell = OnceCell::new(); 140cell.set(< span class ="string "> "hello"</ span > .to_string()).unwrap(); 141< span class ="macro "> assert_eq!</ span > (cell.take(),< span class ="prelude-val "> Some</ span > (< span class ="string "> "hello"</ span > .to_string())); 142< span class ="macro "> assert_eq!</ span > (cell.get(),< span class ="prelude-val "> None</ span > );</ code ></ pre ></ div > 143< p > This method is allowed to violate the invariant of writing to a< code > OnceCell</ code > 144at most once because it requires< code > &mut</ code > access to< code > self</ code > . As with all 145interior mutability,< code > &mut</ code > access permits arbitrary modification:</ p > 146 147< div class ="example-wrap ">< pre class ="rust rust-example-rendered ">< code >< span class ="kw "> use</ span > once_cell::sync::OnceCell; 148 149< span class ="kw "> let</ span >< span class ="kw-2 "> mut</ span > cell: OnceCell<u32> = OnceCell::new(); 150cell.set(< span class ="number "> 92</ span > ).unwrap(); 151cell = OnceCell::new();</ code ></ pre ></ div > 152</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.into_inner "class ="method has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#1167-1169 "> source</ a >< h4 class ="code-header "> pub fn< a href ="#method.into_inner "class ="fnname "> into_inner</ a > (self) ->< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/option/enum.Option.html "title ="enum core::option::Option "> Option</ a > <T></ h4 ></ section ></ summary >< div class ="docblock ">< p > Consumes the< code > OnceCell</ code > , returning the wrapped value. Returns 153< code > None</ code > if the cell was empty.</ p > 154< h5 id ="examples-1 ">< a href ="#examples-1 "> Examples</ a ></ h5 > 155< div class ="example-wrap ">< pre class ="rust rust-example-rendered ">< code >< span class ="kw "> use</ span > once_cell::sync::OnceCell; 156 157< span class ="kw "> let</ span > cell: OnceCell<String> = OnceCell::new(); 158< span class ="macro "> assert_eq!</ span > (cell.into_inner(),< span class ="prelude-val "> None</ span > ); 159 160< span class ="kw "> let</ span > cell = OnceCell::new(); 161cell.set(< span class ="string "> "hello"</ span > .to_string()).unwrap(); 162< span class ="macro "> assert_eq!</ span > (cell.into_inner(),< span class ="prelude-val "> Some</ span > (< span class ="string "> "hello"</ span > .to_string()));</ code ></ pre ></ div > 163</ div ></ details ></ div ></ details ></ div >< h2 id ="trait-implementations "class ="small-section-header "> Trait Implementations< a href ="#trait-implementations "class ="anchor "></ a ></ h2 >< div id ="trait-implementations-list ">< details class ="rustdoc-toggle implementors-toggle "open >< summary >< section id ="impl-Clone-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#873-887 "> source</ a >< a href ="#impl-Clone-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T: < a class ="trait "href ="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html "title ="trait core::clone::Clone "> Clone</ a > >< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html "title ="trait core::clone::Clone "> Clone</ a > for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.clone "class ="method trait-impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#874-879 "> source</ a >< a href ="#method.clone "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone "class ="fnname "> clone</ a > (&self) ->< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h4 ></ section ></ summary >< div class ='docblock '> Returns a copy of the value.< a href ="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone "> Read more</ a ></ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.clone_from "class ="method trait-impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#881-886 "> source</ a >< a href ="#method.clone_from "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from "class ="fnname "> clone_from</ a > (&mut self, source:< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &</ a > Self)</ h4 ></ section ></ summary >< div class ='docblock '> Performs copy-assignment from< code > source</ code > .< a href ="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from "> Read more</ a ></ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle "open >< summary >< section id ="impl-Debug-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#864-871 "> source</ a >< a href ="#impl-Debug-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T: < a class ="trait "href ="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html "title ="trait core::fmt::Debug "> Debug</ a > >< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html "title ="trait core::fmt::Debug "> Debug</ a > for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.fmt "class ="method trait-impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#865-870 "> source</ a >< a href ="#method.fmt "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt "class ="fnname "> fmt</ a > (&self, f: &mut< a class ="struct "href ="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html "title ="struct core::fmt::Formatter "> Formatter</ a > <'_>) ->< a class ="type "href ="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html "title ="type core::fmt::Result "> Result</ a ></ h4 ></ section ></ summary >< div class ='docblock '> Formats the value using the given formatter.< a href ="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt "> Read more</ a ></ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle "open >< summary >< section id ="impl-Default-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#858-862 "> source</ a >< a href ="#impl-Default-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/default/trait.Default.html "title ="trait core::default::Default "> Default</ a > for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.default "class ="method trait-impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#859-861 "> source</ a >< a href ="#method.default "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default "class ="fnname "> default</ a > () ->< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h4 ></ section ></ summary >< div class ='docblock '> Returns the “default value” for a type.< a href ="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default "> Read more</ a ></ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle "open >< summary >< section id ="impl-From%3CT%3E-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#889-893 "> source</ a >< a href ="#impl-From%3CT%3E-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.From.html "title ="trait core::convert::From "> From</ a > <T> for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.from "class ="method trait-impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#890-892 "> source</ a >< a href ="#method.from "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from "class ="fnname "> from</ a > (value: T) -> Self</ h4 ></ section ></ summary >< div class ='docblock '> Converts to this type from the input type.</ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle "open >< summary >< section id ="impl-PartialEq%3COnceCell%3CT%3E%3E-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#895-899 "> source</ a >< a href ="#impl-PartialEq%3COnceCell%3CT%3E%3E-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T: < a class ="trait "href ="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html "title ="trait core::cmp::PartialEq "> PartialEq</ a > >< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html "title ="trait core::cmp::PartialEq "> PartialEq</ a > << a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T>> for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.eq "class ="method trait-impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#896-898 "> source</ a >< a href ="#method.eq "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq "class ="fnname "> eq</ a > (&self, other: &< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T>) ->< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.bool.html "> bool</ a ></ h4 ></ section ></ summary >< div class ='docblock '> This method tests for< code > self</ code > and< code > other</ code > values to be equal, and is used 164by< code > ==</ code > .< a href ="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq "> Read more</ a ></ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.ne "class ="method trait-impl has-srclink ">< span class ="rightside ">< span class ="since "title ="Stable since Rust version 1.0.0 "> 1.0.0</ span > ·< a class ="srclink "href ="https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#226 "> source</ a ></ span >< a href ="#method.ne "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne "class ="fnname "> ne</ a > (&self, other:< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &</ a > Rhs) ->< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.bool.html "> bool</ a ></ h4 ></ section ></ summary >< div class ='docblock '> This method tests for< code > !=</ code > . The default implementation is almost always 165sufficient, and should not be overridden without very good reason.< a href ="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne "> Read more</ a ></ div ></ details ></ div ></ details >< section id ="impl-Eq-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="../../src/once_cell/lib.rs.html#901 "> source</ a >< a href ="#impl-Eq-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T: < a class ="trait "href ="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html "title ="trait core::cmp::Eq "> Eq</ a > >< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html "title ="trait core::cmp::Eq "> Eq</ a > for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T></ h3 ></ section ></ div >< h2 id ="synthetic-implementations "class ="small-section-header "> Auto Trait Implementations< a href ="#synthetic-implementations "class ="anchor "></ a ></ h2 >< div id ="synthetic-implementations-list ">< section id ="impl-RefUnwindSafe-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a href ="#impl-RefUnwindSafe-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html "title ="trait core::panic::unwind_safe::RefUnwindSafe "> RefUnwindSafe</ a > for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T>< span class ="where fmt-newline "> where< br > T:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html "title ="trait core::panic::unwind_safe::UnwindSafe "> UnwindSafe</ a > +< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html "title ="trait core::panic::unwind_safe::RefUnwindSafe "> RefUnwindSafe</ a > ,</ span ></ h3 ></ section >< section id ="impl-Send-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a href ="#impl-Send-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html "title ="trait core::marker::Send "> Send</ a > for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T>< span class ="where fmt-newline "> where< br > T:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html "title ="trait core::marker::Send "> Send</ a > ,</ span ></ h3 ></ section >< section id ="impl-Sync-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a href ="#impl-Sync-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html "title ="trait core::marker::Sync "> Sync</ a > for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T>< span class ="where fmt-newline "> where< br > T:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html "title ="trait core::marker::Send "> Send</ a > +< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html "title ="trait core::marker::Sync "> Sync</ a > ,</ span ></ h3 ></ section >< section id ="impl-Unpin-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a href ="#impl-Unpin-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html "title ="trait core::marker::Unpin "> Unpin</ a > for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T>< span class ="where fmt-newline "> where< br > T:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html "title ="trait core::marker::Unpin "> Unpin</ a > ,</ span ></ h3 ></ section >< section id ="impl-UnwindSafe-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a href ="#impl-UnwindSafe-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html "title ="trait core::panic::unwind_safe::UnwindSafe "> UnwindSafe</ a > for< a class ="struct "href ="struct.OnceCell.html "title ="struct once_cell::sync::OnceCell "> OnceCell</ a > <T>< span class ="where fmt-newline "> where< br > T:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html "title ="trait core::panic::unwind_safe::UnwindSafe "> UnwindSafe</ a > ,</ span ></ h3 ></ section ></ div >< h2 id ="blanket-implementations "class ="small-section-header "> Blanket Implementations< a href ="#blanket-implementations "class ="anchor "></ a ></ h2 >< div id ="blanket-implementations-list ">< details class ="rustdoc-toggle implementors-toggle ">< summary >< section id ="impl-Any-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200 "> source</ a >< a href ="#impl-Any-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/any/trait.Any.html "title ="trait core::any::Any "> Any</ a > for T< span class ="where fmt-newline "> where< br > T: 'static + ?< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html "title ="trait core::marker::Sized "> Sized</ a > ,</ span ></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.type_id "class ="method trait-impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201 "> source</ a >< a href ="#method.type_id "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id "class ="fnname "> type_id</ a > (&self) ->< a class ="struct "href ="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html "title ="struct core::any::TypeId "> TypeId</ a ></ h4 ></ section ></ summary >< div class ='docblock '> Gets the< code > TypeId</ code > of< code > self</ code > .< a href ="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id "> Read more</ a ></ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle ">< summary >< section id ="impl-Borrow%3CT%3E-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211 "> source</ a >< a href ="#impl-Borrow%3CT%3E-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html "title ="trait core::borrow::Borrow "> Borrow</ a > <T> for T< span class ="where fmt-newline "> where< br > T: ?< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html "title ="trait core::marker::Sized "> Sized</ a > ,</ span ></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.borrow "class ="method trait-impl has-srclink ">< span class ="rightside ">< span class ="since "title ="const unstable "> const:< a href ="https://github.com/rust-lang/rust/issues/91522 "title ="Tracking issue for const_borrow "> unstable</ a ></ span > ·< a class ="srclink "href ="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213 "> source</ a ></ span >< a href ="#method.borrow "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow "class ="fnname "> borrow</ a > (&self) ->< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &</ a > T</ h4 ></ section ></ summary >< div class ='docblock '> Immutably borrows from an owned value.< a href ="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow "> Read more</ a ></ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle ">< summary >< section id ="impl-BorrowMut%3CT%3E-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220 "> source</ a >< a href ="#impl-BorrowMut%3CT%3E-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html "title ="trait core::borrow::BorrowMut "> BorrowMut</ a > <T> for T< span class ="where fmt-newline "> where< br > T: ?< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html "title ="trait core::marker::Sized "> Sized</ a > ,</ span ></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.borrow_mut "class ="method trait-impl has-srclink ">< span class ="rightside ">< span class ="since "title ="const unstable "> const:< a href ="https://github.com/rust-lang/rust/issues/91522 "title ="Tracking issue for const_borrow "> unstable</ a ></ span > ·< a class ="srclink "href ="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221 "> source</ a ></ span >< a href ="#method.borrow_mut "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut "class ="fnname "> borrow_mut</ a > (&mut self) ->< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &mut</ a > T</ h4 ></ section ></ summary >< div class ='docblock '> Mutably borrows from an owned value.< a href ="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut "> Read more</ a ></ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle ">< summary >< section id ="impl-From%3C!%3E-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#583 "> source</ a >< a href ="#impl-From%3C!%3E-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.From.html "title ="trait core::convert::From "> From</ a > << a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.never.html "> !</ a > > for T</ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.from-1 "class ="method trait-impl has-srclink ">< span class ="rightside ">< span class ="since "title ="const unstable "> const:< a href ="https://github.com/rust-lang/rust/issues/88674 "title ="Tracking issue for const_convert "> unstable</ a ></ span > ·< a class ="srclink "href ="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#584 "> source</ a ></ span >< a href ="#method.from-1 "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from "class ="fnname "> from</ a > (t:< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.never.html "> !</ a > ) -> T</ h4 ></ section ></ summary >< div class ='docblock '> Converts to this type from the input type.</ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle ">< summary >< section id ="impl-From%3CT%3E-for-OnceCell%3CT%3E-1 "class ="impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#565 "> source</ a >< a href ="#impl-From%3CT%3E-for-OnceCell%3CT%3E-1 "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.From.html "title ="trait core::convert::From "> From</ a > <T> for T</ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.from-2 "class ="method trait-impl has-srclink ">< span class ="rightside ">< span class ="since "title ="const unstable "> const:< a href ="https://github.com/rust-lang/rust/issues/88674 "title ="Tracking issue for const_convert "> unstable</ a ></ span > ·< a class ="srclink "href ="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568 "> source</ a ></ span >< a href ="#method.from-2 "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from "class ="fnname "> from</ a > (t: T) -> T</ h4 ></ section ></ summary >< div class ="docblock ">< p > Returns the argument unchanged.</ p > 166</ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle ">< summary >< section id ="impl-Into%3CU%3E-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#549 "> source</ a >< a href ="#impl-Into%3CU%3E-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T, U>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html "title ="trait core::convert::Into "> Into</ a > <U> for T< span class ="where fmt-newline "> where< br > U:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.From.html "title ="trait core::convert::From "> From</ a > <T>,</ span ></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.into "class ="method trait-impl has-srclink ">< span class ="rightside ">< span class ="since "title ="const unstable "> const:< a href ="https://github.com/rust-lang/rust/issues/88674 "title ="Tracking issue for const_convert "> unstable</ a ></ span > ·< a class ="srclink "href ="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#557 "> source</ a ></ span >< a href ="#method.into "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into "class ="fnname "> into</ a > (self) -> U</ h4 ></ section ></ summary >< div class ="docblock ">< p > Calls< code > U::from(self)</ code > .</ p > 167< p > That is, this conversion is whatever the implementation of 168< code >< a href ="https://doc.rust-lang.org/nightly/core/convert/trait.From.html "title ="From "> From</ a > <T> for U</ code > chooses to do.</ p > 169</ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle ">< summary >< section id ="impl-ToOwned-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#83 "> source</ a >< a href ="#impl-ToOwned-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T>< a class ="trait "href ="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html "title ="trait alloc::borrow::ToOwned "> ToOwned</ a > for T< span class ="where fmt-newline "> where< br > T:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html "title ="trait core::clone::Clone "> Clone</ a > ,</ span ></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle "open >< summary >< section id ="associatedtype.Owned "class ="associatedtype trait-impl has-srclink ">< a href ="#associatedtype.Owned "class ="anchor "></ a >< h4 class ="code-header "> type< a href ="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned "class ="associatedtype "> Owned</ a > = T</ h4 ></ section ></ summary >< div class ='docblock '> The resulting type after obtaining ownership.</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.to_owned "class ="method trait-impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#88 "> source</ a >< a href ="#method.to_owned "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned "class ="fnname "> to_owned</ a > (&self) -> T</ h4 ></ section ></ summary >< div class ='docblock '> Creates owned data from borrowed data, usually by cloning.< a href ="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned "> Read more</ a ></ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.clone_into "class ="method trait-impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#92 "> source</ a >< a href ="#method.clone_into "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into "class ="fnname "> clone_into</ a > (&self, target:< a class ="primitive "href ="https://doc.rust-lang.org/nightly/std/primitive.reference.html "> &mut</ a > T)</ h4 ></ section ></ summary >< div class ='docblock '> Uses borrowed data to replace owned data, usually by cloning.< a href ="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into "> Read more</ a ></ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle ">< summary >< section id ="impl-TryFrom%3CU%3E-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#607 "> source</ a >< a href ="#impl-TryFrom%3CU%3E-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T, U>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html "title ="trait core::convert::TryFrom "> TryFrom</ a > <U> for T< span class ="where fmt-newline "> where< br > U:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html "title ="trait core::convert::Into "> Into</ a > <T>,</ span ></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle "open >< summary >< section id ="associatedtype.Error "class ="associatedtype trait-impl has-srclink ">< a href ="#associatedtype.Error "class ="anchor "></ a >< h4 class ="code-header "> type< a href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error "class ="associatedtype "> Error</ a > =< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html "title ="enum core::convert::Infallible "> Infallible</ a ></ h4 ></ section ></ summary >< div class ='docblock '> The type returned in the event of a conversion error.</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.try_from "class ="method trait-impl has-srclink ">< span class ="rightside ">< span class ="since "title ="const unstable "> const:< a href ="https://github.com/rust-lang/rust/issues/88674 "title ="Tracking issue for const_convert "> unstable</ a ></ span > ·< a class ="srclink "href ="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#613 "> source</ a ></ span >< a href ="#method.try_from "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from "class ="fnname "> try_from</ a > (value: U) ->< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/result/enum.Result.html "title ="enum core::result::Result "> Result</ a > <T, <T as< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html "title ="trait core::convert::TryFrom "> TryFrom</ a > <U>>::< a class ="associatedtype "href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error "title ="type core::convert::TryFrom::Error "> Error</ a > ></ h4 ></ section ></ summary >< div class ='docblock '> Performs the conversion.</ div ></ details ></ div ></ details >< details class ="rustdoc-toggle implementors-toggle ">< summary >< section id ="impl-TryInto%3CU%3E-for-OnceCell%3CT%3E "class ="impl has-srclink ">< a class ="srclink rightside "href ="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#592 "> source</ a >< a href ="#impl-TryInto%3CU%3E-for-OnceCell%3CT%3E "class ="anchor "></ a >< h3 class ="code-header in-band "> impl<T, U>< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html "title ="trait core::convert::TryInto "> TryInto</ a > <U> for T< span class ="where fmt-newline "> where< br > U:< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html "title ="trait core::convert::TryFrom "> TryFrom</ a > <T>,</ span ></ h3 ></ section ></ summary >< div class ="impl-items ">< details class ="rustdoc-toggle "open >< summary >< section id ="associatedtype.Error-1 "class ="associatedtype trait-impl has-srclink ">< a href ="#associatedtype.Error-1 "class ="anchor "></ a >< h4 class ="code-header "> type< a href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error "class ="associatedtype "> Error</ a > = <U as< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html "title ="trait core::convert::TryFrom "> TryFrom</ a > <T>>::< a class ="associatedtype "href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error "title ="type core::convert::TryFrom::Error "> Error</ a ></ h4 ></ section ></ summary >< div class ='docblock '> The type returned in the event of a conversion error.</ div ></ details >< details class ="rustdoc-toggle method-toggle "open >< summary >< section id ="method.try_into "class ="method trait-impl has-srclink ">< span class ="rightside ">< span class ="since "title ="const unstable "> const:< a href ="https://github.com/rust-lang/rust/issues/88674 "title ="Tracking issue for const_convert "> unstable</ a ></ span > ·< a class ="srclink "href ="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#598 "> source</ a ></ span >< a href ="#method.try_into "class ="anchor "></ a >< h4 class ="code-header "> fn< a href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into "class ="fnname "> try_into</ a > (self) ->< a class ="enum "href ="https://doc.rust-lang.org/nightly/core/result/enum.Result.html "title ="enum core::result::Result "> Result</ a > <U, <U as< a class ="trait "href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html "title ="trait core::convert::TryFrom "> TryFrom</ a > <T>>::< a class ="associatedtype "href ="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error "title ="type core::convert::TryFrom::Error "> Error</ a > ></ h4 ></ section ></ summary >< div class ='docblock '> Performs the conversion.</ div ></ details ></ div ></ details ></ div ></ section ></ div ></ main >< div id ="rustdoc-vars "data-root-path ="../../ "data-current-crate ="once_cell "data-themes ="ayu,dark,light "data-resource-suffix =""data-rustdoc-version ="1.66.0-nightly (4a1467723 2022-09-23) "></ div ></ body ></ html >