+/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 ="Source of the Rust file `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/once_cell-1.15.0/src/race.rs`. ">< meta name ="keywords "content ="rust, rustlang, rust-lang ">< title > race.rs - source</ 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 ="../../source-script.js "></ script >< script defer src ="../../source-files.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 source "> <!--[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 ></ 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 ="example-wrap ">< pre class ="line-numbers ">< span id ="1 "> 1</ span > 2< span id ="2 "> 2</ span > 3< span id ="3 "> 3</ span > 4< span id ="4 "> 4</ span > 5< span id ="5 "> 5</ span > 6< span id ="6 "> 6</ span > 7< span id ="7 "> 7</ span > 8< span id ="8 "> 8</ span > 9< span id ="9 "> 9</ span > 10< span id ="10 "> 10</ span > 11< span id ="11 "> 11</ span > 12< span id ="12 "> 12</ span > 13< span id ="13 "> 13</ span > 14< span id ="14 "> 14</ span > 15< span id ="15 "> 15</ span > 16< span id ="16 "> 16</ span > 17< span id ="17 "> 17</ span > 18< span id ="18 "> 18</ span > 19< span id ="19 "> 19</ span > 20< span id ="20 "> 20</ span > 21< span id ="21 "> 21</ span > 22< span id ="22 "> 22</ span > 23< span id ="23 "> 23</ span > 24< span id ="24 "> 24</ span > 25< span id ="25 "> 25</ span > 26< span id ="26 "> 26</ span > 27< span id ="27 "> 27</ span > 28< span id ="28 "> 28</ span > 29< span id ="29 "> 29</ span > 30< span id ="30 "> 30</ span > 31< span id ="31 "> 31</ span > 32< span id ="32 "> 32</ span > 33< span id ="33 "> 33</ span > 34< span id ="34 "> 34</ span > 35< span id ="35 "> 35</ span > 36< span id ="36 "> 36</ span > 37< span id ="37 "> 37</ span > 38< span id ="38 "> 38</ span > 39< span id ="39 "> 39</ span > 40< span id ="40 "> 40</ span > 41< span id ="41 "> 41</ span > 42< span id ="42 "> 42</ span > 43< span id ="43 "> 43</ span > 44< span id ="44 "> 44</ span > 45< span id ="45 "> 45</ span > 46< span id ="46 "> 46</ span > 47< span id ="47 "> 47</ span > 48< span id ="48 "> 48</ span > 49< span id ="49 "> 49</ span > 50< span id ="50 "> 50</ span > 51< span id ="51 "> 51</ span > 52< span id ="52 "> 52</ span > 53< span id ="53 "> 53</ span > 54< span id ="54 "> 54</ span > 55< span id ="55 "> 55</ span > 56< span id ="56 "> 56</ span > 57< span id ="57 "> 57</ span > 58< span id ="58 "> 58</ span > 59< span id ="59 "> 59</ span > 60< span id ="60 "> 60</ span > 61< span id ="61 "> 61</ span > 62< span id ="62 "> 62</ span > 63< span id ="63 "> 63</ span > 64< span id ="64 "> 64</ span > 65< span id ="65 "> 65</ span > 66< span id ="66 "> 66</ span > 67< span id ="67 "> 67</ span > 68< span id ="68 "> 68</ span > 69< span id ="69 "> 69</ span > 70< span id ="70 "> 70</ span > 71< span id ="71 "> 71</ span > 72< span id ="72 "> 72</ span > 73< span id ="73 "> 73</ span > 74< span id ="74 "> 74</ span > 75< span id ="75 "> 75</ span > 76< span id ="76 "> 76</ span > 77< span id ="77 "> 77</ span > 78< span id ="78 "> 78</ span > 79< span id ="79 "> 79</ span > 80< span id ="80 "> 80</ span > 81< span id ="81 "> 81</ span > 82< span id ="82 "> 82</ span > 83< span id ="83 "> 83</ span > 84< span id ="84 "> 84</ span > 85< span id ="85 "> 85</ span > 86< span id ="86 "> 86</ span > 87< span id ="87 "> 87</ span > 88< span id ="88 "> 88</ span > 89< span id ="89 "> 89</ span > 90< span id ="90 "> 90</ span > 91< span id ="91 "> 91</ span > 92< span id ="92 "> 92</ span > 93< span id ="93 "> 93</ span > 94< span id ="94 "> 94</ span > 95< span id ="95 "> 95</ span > 96< span id ="96 "> 96</ span > 97< span id ="97 "> 97</ span > 98< span id ="98 "> 98</ span > 99< span id ="99 "> 99</ span > 100< span id ="100 "> 100</ span > 101< span id ="101 "> 101</ span > 102< span id ="102 "> 102</ span > 103< span id ="103 "> 103</ span > 104< span id ="104 "> 104</ span > 105< span id ="105 "> 105</ span > 106< span id ="106 "> 106</ span > 107< span id ="107 "> 107</ span > 108< span id ="108 "> 108</ span > 109< span id ="109 "> 109</ span > 110< span id ="110 "> 110</ span > 111< span id ="111 "> 111</ span > 112< span id ="112 "> 112</ span > 113< span id ="113 "> 113</ span > 114< span id ="114 "> 114</ span > 115< span id ="115 "> 115</ span > 116< span id ="116 "> 116</ span > 117< span id ="117 "> 117</ span > 118< span id ="118 "> 118</ span > 119< span id ="119 "> 119</ span > 120< span id ="120 "> 120</ span > 121< span id ="121 "> 121</ span > 122< span id ="122 "> 122</ span > 123< span id ="123 "> 123</ span > 124< span id ="124 "> 124</ span > 125< span id ="125 "> 125</ span > 126< span id ="126 "> 126</ span > 127< span id ="127 "> 127</ span > 128< span id ="128 "> 128</ span > 129< span id ="129 "> 129</ span > 130< span id ="130 "> 130</ span > 131< span id ="131 "> 131</ span > 132< span id ="132 "> 132</ span > 133< span id ="133 "> 133</ span > 134< span id ="134 "> 134</ span > 135< span id ="135 "> 135</ span > 136< span id ="136 "> 136</ span > 137< span id ="137 "> 137</ span > 138< span id ="138 "> 138</ span > 139< span id ="139 "> 139</ span > 140< span id ="140 "> 140</ span > 141< span id ="141 "> 141</ span > 142< span id ="142 "> 142</ span > 143< span id ="143 "> 143</ span > 144< span id ="144 "> 144</ span > 145< span id ="145 "> 145</ span > 146< span id ="146 "> 146</ span > 147< span id ="147 "> 147</ span > 148< span id ="148 "> 148</ span > 149< span id ="149 "> 149</ span > 150< span id ="150 "> 150</ span > 151< span id ="151 "> 151</ span > 152< span id ="152 "> 152</ span > 153< span id ="153 "> 153</ span > 154< span id ="154 "> 154</ span > 155< span id ="155 "> 155</ span > 156< span id ="156 "> 156</ span > 157< span id ="157 "> 157</ span > 158< span id ="158 "> 158</ span > 159< span id ="159 "> 159</ span > 160< span id ="160 "> 160</ span > 161< span id ="161 "> 161</ span > 162< span id ="162 "> 162</ span > 163< span id ="163 "> 163</ span > 164< span id ="164 "> 164</ span > 165< span id ="165 "> 165</ span > 166< span id ="166 "> 166</ span > 167< span id ="167 "> 167</ span > 168< span id ="168 "> 168</ span > 169< span id ="169 "> 169</ span > 170< span id ="170 "> 170</ span > 171< span id ="171 "> 171</ span > 172< span id ="172 "> 172</ span > 173< span id ="173 "> 173</ span > 174< span id ="174 "> 174</ span > 175< span id ="175 "> 175</ span > 176< span id ="176 "> 176</ span > 177< span id ="177 "> 177</ span > 178< span id ="178 "> 178</ span > 179< span id ="179 "> 179</ span > 180< span id ="180 "> 180</ span > 181< span id ="181 "> 181</ span > 182< span id ="182 "> 182</ span > 183< span id ="183 "> 183</ span > 184< span id ="184 "> 184</ span > 185< span id ="185 "> 185</ span > 186< span id ="186 "> 186</ span > 187< span id ="187 "> 187</ span > 188< span id ="188 "> 188</ span > 189< span id ="189 "> 189</ span > 190< span id ="190 "> 190</ span > 191< span id ="191 "> 191</ span > 192< span id ="192 "> 192</ span > 193< span id ="193 "> 193</ span > 194< span id ="194 "> 194</ span > 195< span id ="195 "> 195</ span > 196< span id ="196 "> 196</ span > 197< span id ="197 "> 197</ span > 198< span id ="198 "> 198</ span > 199< span id ="199 "> 199</ span > 200< span id ="200 "> 200</ span > 201< span id ="201 "> 201</ span > 202< span id ="202 "> 202</ span > 203< span id ="203 "> 203</ span > 204< span id ="204 "> 204</ span > 205< span id ="205 "> 205</ span > 206< span id ="206 "> 206</ span > 207< span id ="207 "> 207</ span > 208< span id ="208 "> 208</ span > 209< span id ="209 "> 209</ span > 210< span id ="210 "> 210</ span > 211< span id ="211 "> 211</ span > 212< span id ="212 "> 212</ span > 213< span id ="213 "> 213</ span > 214< span id ="214 "> 214</ span > 215< span id ="215 "> 215</ span > 216< span id ="216 "> 216</ span > 217< span id ="217 "> 217</ span > 218< span id ="218 "> 218</ span > 219< span id ="219 "> 219</ span > 220< span id ="220 "> 220</ span > 221< span id ="221 "> 221</ span > 222< span id ="222 "> 222</ span > 223< span id ="223 "> 223</ span > 224< span id ="224 "> 224</ span > 225< span id ="225 "> 225</ span > 226< span id ="226 "> 226</ span > 227< span id ="227 "> 227</ span > 228< span id ="228 "> 228</ span > 229< span id ="229 "> 229</ span > 230< span id ="230 "> 230</ span > 231< span id ="231 "> 231</ span > 232< span id ="232 "> 232</ span > 233< span id ="233 "> 233</ span > 234< span id ="234 "> 234</ span > 235< span id ="235 "> 235</ span > 236< span id ="236 "> 236</ span > 237< span id ="237 "> 237</ span > 238< span id ="238 "> 238</ span > 239< span id ="239 "> 239</ span > 240< span id ="240 "> 240</ span > 241< span id ="241 "> 241</ span > 242< span id ="242 "> 242</ span > 243< span id ="243 "> 243</ span > 244< span id ="244 "> 244</ span > 245< span id ="245 "> 245</ span > 246< span id ="246 "> 246</ span > 247< span id ="247 "> 247</ span > 248< span id ="248 "> 248</ span > 249< span id ="249 "> 249</ span > 250< span id ="250 "> 250</ span > 251< span id ="251 "> 251</ span > 252< span id ="252 "> 252</ span > 253< span id ="253 "> 253</ span > 254< span id ="254 "> 254</ span > 255< span id ="255 "> 255</ span > 256< span id ="256 "> 256</ span > 257< span id ="257 "> 257</ span > 258< span id ="258 "> 258</ span > 259< span id ="259 "> 259</ span > 260< span id ="260 "> 260</ span > 261< span id ="261 "> 261</ span > 262< span id ="262 "> 262</ span > 263< span id ="263 "> 263</ span > 264< span id ="264 "> 264</ span > 265< span id ="265 "> 265</ span > 266< span id ="266 "> 266</ span > 267< span id ="267 "> 267</ span > 268< span id ="268 "> 268</ span > 269< span id ="269 "> 269</ span > 270< span id ="270 "> 270</ span > 271< span id ="271 "> 271</ span > 272< span id ="272 "> 272</ span > 273< span id ="273 "> 273</ span > 274< span id ="274 "> 274</ span > 275< span id ="275 "> 275</ span > 276< span id ="276 "> 276</ span > 277< span id ="277 "> 277</ span > 278< span id ="278 "> 278</ span > 279< span id ="279 "> 279</ span > 280< span id ="280 "> 280</ span > 281< span id ="281 "> 281</ span > 282< span id ="282 "> 282</ span > 283< span id ="283 "> 283</ span > 284< span id ="284 "> 284</ span > 285< span id ="285 "> 285</ span > 286< span id ="286 "> 286</ span > 287< span id ="287 "> 287</ span > 288< span id ="288 "> 288</ span > 289< span id ="289 "> 289</ span > 290< span id ="290 "> 290</ span > 291< span id ="291 "> 291</ span > 292< span id ="292 "> 292</ span > 293< span id ="293 "> 293</ span > 294< span id ="294 "> 294</ span > 295< span id ="295 "> 295</ span > 296< span id ="296 "> 296</ span > 297< span id ="297 "> 297</ span > 298< span id ="298 "> 298</ span > 299< span id ="299 "> 299</ span > 300< span id ="300 "> 300</ span > 301< span id ="301 "> 301</ span > 302< span id ="302 "> 302</ span > 303< span id ="303 "> 303</ span > 304</ pre >< pre class ="rust ">< code >< span class ="doccomment "> //! Thread-safe, non-blocking, "first one wins" flavor of `OnceCell`. 305//! 306//! If two threads race to initialize a type from the `race` module, they 307//! don't block, execute initialization function together, but only one of 308//! them stores the result. 309//! 310//! This module does not require `std` feature. 311//! 312//! # Atomic orderings 313//! 314//! All types in this module use `Acquire` and `Release` 315//! [atomic orderings](Ordering) for all their operations. While this is not 316//! strictly necessary for types other than `OnceBox`, it is useful for users as 317//! it allows them to be certain that after `get` or `get_or_init` returns on 318//! one thread, any side-effects caused by the setter thread prior to them 319//! calling `set` or `get_or_init` will be made visible to that thread; without 320//! it, it's possible for it to appear as if they haven't happened yet from the 321//! getter thread's perspective. This is an acceptable tradeoff to make since 322//! `Acquire` and `Release` have very little performance overhead on most 323//! architectures versus `Relaxed`. 324 325</ span >< span class ="attribute "> #[cfg(feature =< span class ="string "> "atomic-polyfill"</ span > )] 326</ span >< span class ="kw "> use</ span > atomic_polyfill< span class ="kw "> as</ span > atomic; 327< span class ="attribute "> #[cfg(not(feature =< span class ="string "> "atomic-polyfill"</ span > ))] 328</ span >< span class ="kw "> use</ span > core::sync::atomic; 329 330< span class ="kw "> use</ span > atomic::{AtomicUsize, Ordering}; 331< span class ="kw "> use</ span > core::num::NonZeroUsize; 332 333< span class ="doccomment "> /// A thread-safe cell which can be written to only once. 334</ span >< span class ="attribute "> #[derive(Default, Debug)] 335</ span >< span class ="kw "> pub struct</ span > OnceNonZeroUsize { 336 inner: AtomicUsize, 337} 338 339< span class ="kw "> impl</ span > OnceNonZeroUsize { 340< span class ="doccomment "> /// Creates a new empty cell. 341</ span >< span class ="attribute "> #[inline] 342</ span >< span class ="kw "> pub const fn</ span > new() -> OnceNonZeroUsize { 343 OnceNonZeroUsize { inner: AtomicUsize::new(< span class ="number "> 0</ span > ) } 344 } 345 346< span class ="doccomment "> /// Gets the underlying value. 347</ span >< span class ="attribute "> #[inline] 348</ span >< span class ="kw "> pub fn</ span > get(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > ) ->< span class ="prelude-ty "> Option</ span > <NonZeroUsize> { 349< span class ="kw "> let</ span > val =< span class ="self "> self</ span > .inner.load(Ordering::Acquire); 350 NonZeroUsize::new(val) 351 } 352 353< span class ="doccomment "> /// Sets the contents of this cell to `value`. 354 /// 355 /// Returns `Ok(())` if the cell was empty and `Err(())` if it was 356 /// full. 357</ span >< span class ="attribute "> #[inline] 358</ span >< span class ="kw "> pub fn</ span > set(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , value: NonZeroUsize) ->< span class ="prelude-ty "> Result</ span > <(), ()> { 359< span class ="kw "> let</ span > exchange = 360< span class ="self "> self</ span > .inner.compare_exchange(< span class ="number "> 0</ span > , value.get(), Ordering::AcqRel, Ordering::Acquire); 361< span class ="kw "> match</ span > exchange { 362< span class ="prelude-val "> Ok</ span > (< span class ="kw "> _</ span > ) =>< span class ="prelude-val "> Ok</ span > (()), 363< span class ="prelude-val "> Err</ span > (< span class ="kw "> _</ span > ) =>< span class ="prelude-val "> Err</ span > (()), 364 } 365 } 366 367< span class ="doccomment "> /// Gets the contents of the cell, initializing it with `f` if the cell was 368 /// empty. 369 /// 370 /// If several threads concurrently run `get_or_init`, more than one `f` can 371 /// be called. However, all threads will return the same value, produced by 372 /// some `f`. 373</ span >< span class ="kw "> pub fn</ span > get_or_init<F>(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , f: F) -> NonZeroUsize 374< span class ="kw "> where 375</ span > F: FnOnce() -> NonZeroUsize, 376 { 377< span class ="kw "> enum</ span > Void {} 378< span class ="kw "> match</ span >< span class ="self "> self</ span > .get_or_try_init(||< span class ="prelude-val "> Ok</ span > ::<NonZeroUsize, Void>(f())) { 379< span class ="prelude-val "> Ok</ span > (val) => val, 380< span class ="prelude-val "> Err</ span > (void) =>< span class ="kw "> match</ span > void {}, 381 } 382 } 383 384< span class ="doccomment "> /// Gets the contents of the cell, initializing it with `f` if 385 /// the cell was empty. If the cell was empty and `f` failed, an 386 /// error is returned. 387 /// 388 /// If several threads concurrently run `get_or_init`, more than one `f` can 389 /// be called. However, all threads will return the same value, produced by 390 /// some `f`. 391</ span >< span class ="kw "> pub fn</ span > get_or_try_init<F, E>(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , f: F) ->< span class ="prelude-ty "> Result</ span > <NonZeroUsize, E> 392< span class ="kw "> where 393</ span > F: FnOnce() ->< span class ="prelude-ty "> Result</ span > <NonZeroUsize, E>, 394 { 395< span class ="kw "> let</ span > val =< span class ="self "> self</ span > .inner.load(Ordering::Acquire); 396< span class ="kw "> let</ span > res =< span class ="kw "> match</ span > NonZeroUsize::new(val) { 397< span class ="prelude-val "> Some</ span > (it) => it, 398< span class ="prelude-val "> None</ span > => { 399< span class ="kw "> let</ span >< span class ="kw-2 "> mut</ span > val = f()< span class ="question-mark "> ?</ span > .get(); 400< span class ="kw "> let</ span > exchange = 401< span class ="self "> self</ span > .inner.compare_exchange(< span class ="number "> 0</ span > , val, Ordering::AcqRel, Ordering::Acquire); 402< span class ="kw "> if let</ span >< span class ="prelude-val "> Err</ span > (old) = exchange { 403 val = old; 404 } 405< span class ="kw "> unsafe</ span > { NonZeroUsize::new_unchecked(val) } 406 } 407 }; 408< span class ="prelude-val "> Ok</ span > (res) 409 } 410} 411 412< span class ="doccomment "> /// A thread-safe cell which can be written to only once. 413</ span >< span class ="attribute "> #[derive(Default, Debug)] 414</ span >< span class ="kw "> pub struct</ span > OnceBool { 415 inner: OnceNonZeroUsize, 416} 417 418< span class ="kw "> impl</ span > OnceBool { 419< span class ="doccomment "> /// Creates a new empty cell. 420</ span >< span class ="attribute "> #[inline] 421</ span >< span class ="kw "> pub const fn</ span > new() -> OnceBool { 422 OnceBool { inner: OnceNonZeroUsize::new() } 423 } 424 425< span class ="doccomment "> /// Gets the underlying value. 426</ span >< span class ="attribute "> #[inline] 427</ span >< span class ="kw "> pub fn</ span > get(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > ) ->< span class ="prelude-ty "> Option</ span > <bool> { 428< span class ="self "> self</ span > .inner.get().map(OnceBool::from_usize) 429 } 430 431< span class ="doccomment "> /// Sets the contents of this cell to `value`. 432 /// 433 /// Returns `Ok(())` if the cell was empty and `Err(())` if it was 434 /// full. 435</ span >< span class ="attribute "> #[inline] 436</ span >< span class ="kw "> pub fn</ span > set(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , value: bool) ->< span class ="prelude-ty "> Result</ span > <(), ()> { 437< span class ="self "> self</ span > .inner.set(OnceBool::to_usize(value)) 438 } 439 440< span class ="doccomment "> /// Gets the contents of the cell, initializing it with `f` if the cell was 441 /// empty. 442 /// 443 /// If several threads concurrently run `get_or_init`, more than one `f` can 444 /// be called. However, all threads will return the same value, produced by 445 /// some `f`. 446</ span >< span class ="kw "> pub fn</ span > get_or_init<F>(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , f: F) -> bool 447< span class ="kw "> where 448</ span > F: FnOnce() -> bool, 449 { 450 OnceBool::from_usize(< span class ="self "> self</ span > .inner.get_or_init(|| OnceBool::to_usize(f()))) 451 } 452 453< span class ="doccomment "> /// Gets the contents of the cell, initializing it with `f` if 454 /// the cell was empty. If the cell was empty and `f` failed, an 455 /// error is returned. 456 /// 457 /// If several threads concurrently run `get_or_init`, more than one `f` can 458 /// be called. However, all threads will return the same value, produced by 459 /// some `f`. 460</ span >< span class ="kw "> pub fn</ span > get_or_try_init<F, E>(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , f: F) ->< span class ="prelude-ty "> Result</ span > <bool, E> 461< span class ="kw "> where 462</ span > F: FnOnce() ->< span class ="prelude-ty "> Result</ span > <bool, E>, 463 { 464< span class ="self "> self</ span > .inner.get_or_try_init(|| f().map(OnceBool::to_usize)).map(OnceBool::from_usize) 465 } 466 467< span class ="attribute "> #[inline] 468</ span >< span class ="kw "> fn</ span > from_usize(value: NonZeroUsize) -> bool { 469 value.get() ==< span class ="number "> 1 470</ span > } 471< span class ="attribute "> #[inline] 472</ span >< span class ="kw "> fn</ span > to_usize(value: bool) -> NonZeroUsize { 473< span class ="kw "> unsafe</ span > { NonZeroUsize::new_unchecked(< span class ="kw "> if</ span > value {< span class ="number "> 1</ span > }< span class ="kw "> else</ span > {< span class ="number "> 2</ span > }) } 474 } 475} 476 477< span class ="attribute "> #[cfg(feature =< span class ="string "> "alloc"</ span > )] 478</ span >< span class ="kw "> pub use</ span >< span class ="self "> self</ span > ::once_box::OnceBox; 479 480< span class ="attribute "> #[cfg(feature =< span class ="string "> "alloc"</ span > )] 481</ span >< span class ="kw "> mod</ span > once_box { 482< span class ="kw "> use</ span >< span class ="kw "> super</ span > ::atomic::{AtomicPtr, Ordering}; 483< span class ="kw "> use</ span > core::{marker::PhantomData, ptr}; 484 485< span class ="kw "> use</ span > alloc::boxed::Box; 486 487< span class ="doccomment "> /// A thread-safe cell which can be written to only once. 488</ span >< span class ="kw "> pub struct</ span > OnceBox<T> { 489 inner: AtomicPtr<T>, 490 ghost: PhantomData<< span class ="prelude-ty "> Option</ span > <Box<T>>>, 491 } 492 493< span class ="kw "> impl</ span > <T> core::fmt::Debug< span class ="kw "> for</ span > OnceBox<T> { 494< span class ="kw "> fn</ span > fmt(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , f:< span class ="kw-2 "> &mut</ span > core::fmt::Formatter<< span class ="lifetime "> '_</ span > >) -> core::fmt::Result { 495< span class ="macro "> write!</ span > (f,< span class ="string "> "OnceBox({:?})"</ span > ,< span class ="self "> self</ span > .inner.load(Ordering::Relaxed)) 496 } 497 } 498 499< span class ="kw "> impl</ span > <T> Default< span class ="kw "> for</ span > OnceBox<T> { 500< span class ="kw "> fn</ span > default() ->< span class ="self "> Self</ span > { 501< span class ="self "> Self</ span > ::new() 502 } 503 } 504 505< span class ="kw "> impl</ span > <T> Drop< span class ="kw "> for</ span > OnceBox<T> { 506< span class ="kw "> fn</ span > drop(< span class ="kw-2 "> &mut</ span >< span class ="self "> self</ span > ) { 507< span class ="kw "> let</ span > ptr =< span class ="kw-2 "> *</ span >< span class ="self "> self</ span > .inner.get_mut(); 508< span class ="kw "> if</ span > !ptr.is_null() { 509 drop(< span class ="kw "> unsafe</ span > { Box::from_raw(ptr) }) 510 } 511 } 512 } 513 514< span class ="kw "> impl</ span > <T> OnceBox<T> { 515< span class ="doccomment "> /// Creates a new empty cell. 516</ span >< span class ="kw "> pub const fn</ span > new() -> OnceBox<T> { 517 OnceBox { inner: AtomicPtr::new(ptr::null_mut()), ghost: PhantomData } 518 } 519 520< span class ="doccomment "> /// Gets a reference to the underlying value. 521</ span >< span class ="kw "> pub fn</ span > get(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > ) ->< span class ="prelude-ty "> Option</ span > << span class ="kw-2 "> &</ span > T> { 522< span class ="kw "> let</ span > ptr =< span class ="self "> self</ span > .inner.load(Ordering::Acquire); 523< span class ="kw "> if</ span > ptr.is_null() { 524< span class ="kw "> return</ span >< span class ="prelude-val "> None</ span > ; 525 } 526< span class ="prelude-val "> Some</ span > (< span class ="kw "> unsafe</ span > {< span class ="kw-2 "> &*</ span > ptr }) 527 } 528 529< span class ="doccomment "> /// Sets the contents of this cell to `value`. 530 /// 531 /// Returns `Ok(())` if the cell was empty and `Err(value)` if it was 532 /// full. 533</ span >< span class ="kw "> pub fn</ span > set(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , value: Box<T>) ->< span class ="prelude-ty "> Result</ span > <(), Box<T>> { 534< span class ="kw "> let</ span > ptr = Box::into_raw(value); 535< span class ="kw "> let</ span > exchange =< span class ="self "> self</ span > .inner.compare_exchange( 536 ptr::null_mut(), 537 ptr, 538 Ordering::AcqRel, 539 Ordering::Acquire, 540 ); 541< span class ="kw "> if let</ span >< span class ="prelude-val "> Err</ span > (< span class ="kw "> _</ span > ) = exchange { 542< span class ="kw "> let</ span > value =< span class ="kw "> unsafe</ span > { Box::from_raw(ptr) }; 543< span class ="kw "> return</ span >< span class ="prelude-val "> Err</ span > (value); 544 } 545< span class ="prelude-val "> Ok</ span > (()) 546 } 547 548< span class ="doccomment "> /// Gets the contents of the cell, initializing it with `f` if the cell was 549 /// empty. 550 /// 551 /// If several threads concurrently run `get_or_init`, more than one `f` can 552 /// be called. However, all threads will return the same value, produced by 553 /// some `f`. 554</ span >< span class ="kw "> pub fn</ span > get_or_init<F>(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , f: F) ->< span class ="kw-2 "> &</ span > T 555< span class ="kw "> where 556</ span > F: FnOnce() -> Box<T>, 557 { 558< span class ="kw "> enum</ span > Void {} 559< span class ="kw "> match</ span >< span class ="self "> self</ span > .get_or_try_init(||< span class ="prelude-val "> Ok</ span > ::<Box<T>, Void>(f())) { 560< span class ="prelude-val "> Ok</ span > (val) => val, 561< span class ="prelude-val "> Err</ span > (void) =>< span class ="kw "> match</ span > void {}, 562 } 563 } 564 565< span class ="doccomment "> /// Gets the contents of the cell, initializing it with `f` if 566 /// the cell was empty. If the cell was empty and `f` failed, an 567 /// error is returned. 568 /// 569 /// If several threads concurrently run `get_or_init`, more than one `f` can 570 /// be called. However, all threads will return the same value, produced by 571 /// some `f`. 572</ span >< span class ="kw "> pub fn</ span > get_or_try_init<F, E>(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , f: F) ->< span class ="prelude-ty "> Result</ span > << span class ="kw-2 "> &</ span > T, E> 573< span class ="kw "> where 574</ span > F: FnOnce() ->< span class ="prelude-ty "> Result</ span > <Box<T>, E>, 575 { 576< span class ="kw "> let</ span >< span class ="kw-2 "> mut</ span > ptr =< span class ="self "> self</ span > .inner.load(Ordering::Acquire); 577 578< span class ="kw "> if</ span > ptr.is_null() { 579< span class ="kw "> let</ span > val = f()< span class ="question-mark "> ?</ span > ; 580 ptr = Box::into_raw(val); 581< span class ="kw "> let</ span > exchange =< span class ="self "> self</ span > .inner.compare_exchange( 582 ptr::null_mut(), 583 ptr, 584 Ordering::AcqRel, 585 Ordering::Acquire, 586 ); 587< span class ="kw "> if let</ span >< span class ="prelude-val "> Err</ span > (old) = exchange { 588 drop(< span class ="kw "> unsafe</ span > { Box::from_raw(ptr) }); 589 ptr = old; 590 } 591 }; 592< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > {< span class ="kw-2 "> &*</ span > ptr }) 593 } 594 } 595 596< span class ="kw "> unsafe impl</ span > <T: Sync + Send> Sync< span class ="kw "> for</ span > OnceBox<T> {} 597 598< span class ="doccomment "> /// ```compile_fail 599 /// struct S(*mut ()); 600 /// unsafe impl Sync for S {} 601 /// 602 /// fn share<T: Sync>(_: &T) {} 603 /// share(&once_cell::race::OnceBox::<S>::new()); 604 /// ``` 605</ span >< span class ="kw "> fn</ span > _dummy() {} 606} 607</ code ></ pre ></ div > 608</ 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 >