+/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/bytemuck-1.12.1/src/internal.rs`. ">< meta name ="keywords "content ="rust, rustlang, rust-lang ">< title > internal.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 ="../../bytemuck/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 ="../../bytemuck/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 ="../../bytemuck/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< span id ="304 "> 304</ span > 305< span id ="305 "> 305</ span > 306< span id ="306 "> 306</ span > 307< span id ="307 "> 307</ span > 308< span id ="308 "> 308</ span > 309< span id ="309 "> 309</ span > 310< span id ="310 "> 310</ span > 311< span id ="311 "> 311</ span > 312< span id ="312 "> 312</ span > 313< span id ="313 "> 313</ span > 314< span id ="314 "> 314</ span > 315< span id ="315 "> 315</ span > 316< span id ="316 "> 316</ span > 317< span id ="317 "> 317</ span > 318< span id ="318 "> 318</ span > 319< span id ="319 "> 319</ span > 320< span id ="320 "> 320</ span > 321< span id ="321 "> 321</ span > 322< span id ="322 "> 322</ span > 323< span id ="323 "> 323</ span > 324< span id ="324 "> 324</ span > 325< span id ="325 "> 325</ span > 326< span id ="326 "> 326</ span > 327< span id ="327 "> 327</ span > 328< span id ="328 "> 328</ span > 329< span id ="329 "> 329</ span > 330< span id ="330 "> 330</ span > 331< span id ="331 "> 331</ span > 332< span id ="332 "> 332</ span > 333< span id ="333 "> 333</ span > 334< span id ="334 "> 334</ span > 335< span id ="335 "> 335</ span > 336< span id ="336 "> 336</ span > 337< span id ="337 "> 337</ span > 338< span id ="338 "> 338</ span > 339< span id ="339 "> 339</ span > 340< span id ="340 "> 340</ span > 341< span id ="341 "> 341</ span > 342< span id ="342 "> 342</ span > 343< span id ="343 "> 343</ span > 344< span id ="344 "> 344</ span > 345< span id ="345 "> 345</ span > 346< span id ="346 "> 346</ span > 347< span id ="347 "> 347</ span > 348< span id ="348 "> 348</ span > 349< span id ="349 "> 349</ span > 350< span id ="350 "> 350</ span > 351< span id ="351 "> 351</ span > 352< span id ="352 "> 352</ span > 353< span id ="353 "> 353</ span > 354< span id ="354 "> 354</ span > 355< span id ="355 "> 355</ span > 356< span id ="356 "> 356</ span > 357< span id ="357 "> 357</ span > 358< span id ="358 "> 358</ span > 359< span id ="359 "> 359</ span > 360< span id ="360 "> 360</ span > 361< span id ="361 "> 361</ span > 362< span id ="362 "> 362</ span > 363< span id ="363 "> 363</ span > 364< span id ="364 "> 364</ span > 365< span id ="365 "> 365</ span > 366< span id ="366 "> 366</ span > 367< span id ="367 "> 367</ span > 368< span id ="368 "> 368</ span > 369< span id ="369 "> 369</ span > 370< span id ="370 "> 370</ span > 371< span id ="371 "> 371</ span > 372< span id ="372 "> 372</ span > 373< span id ="373 "> 373</ span > 374< span id ="374 "> 374</ span > 375< span id ="375 "> 375</ span > 376< span id ="376 "> 376</ span > 377< span id ="377 "> 377</ span > 378< span id ="378 "> 378</ span > 379< span id ="379 "> 379</ span > 380< span id ="380 "> 380</ span > 381</ pre >< pre class ="rust ">< code >< span class ="doccomment "> //! Internal implementation of casting functions not bound by marker traits 382//! and therefore marked as unsafe. This is used so that we don't need to 383//! duplicate the business logic contained in these functions between the 384//! versions exported in the crate root, `checked`, and `relaxed` modules. 385</ span >< span class ="attribute "> #![allow(unused_unsafe)] 386 387</ span >< span class ="kw "> use</ span >< span class ="kw "> crate</ span > ::PodCastError; 388< span class ="kw "> use</ span > core::{marker::< span class ="kw-2 "> *</ span > , mem::< span class ="kw-2 "> *</ span > }; 389 390< span class ="comment "> /* 391 392Note(Lokathor): We've switched all of the `unwrap` to `match` because there is 393apparently a bug: https://github.com/rust-lang/rust/issues/68667 394and it doesn't seem to show up in simple godbolt examples but has been reported 395as having an impact when there's a cast mixed in with other more complicated 396code around it. Rustc/LLVM ends up missing that the `Err` can't ever happen for 397particular type combinations, and then it doesn't fully eliminated the panic 398possibility code branch. 399 400*/ 401 402</ span >< span class ="doccomment "> /// Immediately panics. 403</ span >< span class ="attribute "> #[cfg(not(target_arch =< span class ="string "> "spirv"</ span > ))] 404#[cold] 405#[inline(never)] 406</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> fn</ span > something_went_wrong<D: core::fmt::Display>(_src:< span class ="kw-2 "> &</ span > str, _err: D) -> ! { 407< span class ="comment "> // Note(Lokathor): Keeping the panic here makes the panic _formatting_ go 408 // here too, which helps assembly readability and also helps keep down 409 // the inline pressure. 410</ span >< span class ="macro "> panic!</ span > (< span class ="string "> "{src}>{err}"</ span > , src = _src, err = _err); 411} 412 413< span class ="doccomment "> /// Immediately panics. 414</ span >< span class ="attribute "> #[cfg(target_arch =< span class ="string "> "spirv"</ span > )] 415#[cold] 416#[inline(never)] 417</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> fn</ span > something_went_wrong<D>(_src:< span class ="kw-2 "> &</ span > str, _err: D) -> ! { 418< span class ="comment "> // Note: On the spirv targets from [rust-gpu](https://github.com/EmbarkStudios/rust-gpu) 419 // panic formatting cannot be used. We we just give a generic error message 420 // The chance that the panicking version of these functions will ever get 421 // called on spir-v targets with invalid inputs is small, but giving a 422 // simple error message is better than no error message at all. 423</ span >< span class ="macro "> panic!</ span > (< span class ="string "> "Called a panicing helper from bytemuck which paniced"</ span > ); 424} 425 426< span class ="doccomment "> /// Re-interprets `&T` as `&[u8]`. 427/// 428/// Any ZST becomes an empty slice, and in that case the pointer value of that 429/// empty slice might not match the pointer value of the input reference. 430</ span >< span class ="attribute "> #[inline(always)] 431</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > bytes_of<T: Copy>(t:< span class ="kw-2 "> &</ span > T) ->< span class ="kw-2 "> &</ span > [u8] { 432< span class ="kw "> if</ span > size_of::<T>() ==< span class ="number "> 0</ span > { 433< span class ="kw-2 "> &</ span > [] 434 }< span class ="kw "> else</ span > { 435< span class ="kw "> match</ span > try_cast_slice::<T, u8>(core::slice::from_ref(t)) { 436< span class ="prelude-val "> Ok</ span > (s) => s, 437< span class ="prelude-val "> Err</ span > (< span class ="kw "> _</ span > ) =>< span class ="macro "> unreachable!</ span > (), 438 } 439 } 440} 441 442< span class ="doccomment "> /// Re-interprets `&mut T` as `&mut [u8]`. 443/// 444/// Any ZST becomes an empty slice, and in that case the pointer value of that 445/// empty slice might not match the pointer value of the input reference. 446</ span >< span class ="attribute "> #[inline] 447</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > bytes_of_mut<T: Copy>(t:< span class ="kw-2 "> &mut</ span > T) ->< span class ="kw-2 "> &mut</ span > [u8] { 448< span class ="kw "> if</ span > size_of::<T>() ==< span class ="number "> 0</ span > { 449< span class ="kw-2 "> &mut</ span > [] 450 }< span class ="kw "> else</ span > { 451< span class ="kw "> match</ span > try_cast_slice_mut::<T, u8>(core::slice::from_mut(t)) { 452< span class ="prelude-val "> Ok</ span > (s) => s, 453< span class ="prelude-val "> Err</ span > (< span class ="kw "> _</ span > ) =>< span class ="macro "> unreachable!</ span > (), 454 } 455 } 456} 457 458< span class ="doccomment "> /// Re-interprets `&[u8]` as `&T`. 459/// 460/// ## Panics 461/// 462/// This is [`try_from_bytes`] but will panic on error. 463</ span >< span class ="attribute "> #[inline] 464</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > from_bytes<T: Copy>(s:< span class ="kw-2 "> &</ span > [u8]) ->< span class ="kw-2 "> &</ span > T { 465< span class ="kw "> match</ span > try_from_bytes(s) { 466< span class ="prelude-val "> Ok</ span > (t) => t, 467< span class ="prelude-val "> Err</ span > (e) => something_went_wrong(< span class ="string "> "from_bytes"</ span > , e), 468 } 469} 470 471< span class ="doccomment "> /// Re-interprets `&mut [u8]` as `&mut T`. 472/// 473/// ## Panics 474/// 475/// This is [`try_from_bytes_mut`] but will panic on error. 476</ span >< span class ="attribute "> #[inline] 477</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > from_bytes_mut<T: Copy>(s:< span class ="kw-2 "> &mut</ span > [u8]) ->< span class ="kw-2 "> &mut</ span > T { 478< span class ="kw "> match</ span > try_from_bytes_mut(s) { 479< span class ="prelude-val "> Ok</ span > (t) => t, 480< span class ="prelude-val "> Err</ span > (e) => something_went_wrong(< span class ="string "> "from_bytes_mut"</ span > , e), 481 } 482} 483 484< span class ="doccomment "> /// Reads from the bytes as if they were a `T`. 485/// 486/// ## Failure 487/// * If the `bytes` length is not equal to `size_of::<T>()`. 488</ span >< span class ="attribute "> #[inline] 489</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > try_pod_read_unaligned<T: Copy>( 490 bytes:< span class ="kw-2 "> &</ span > [u8], 491) ->< span class ="prelude-ty "> Result</ span > <T, PodCastError> { 492< span class ="kw "> if</ span > bytes.len() != size_of::<T>() { 493< span class ="prelude-val "> Err</ span > (PodCastError::SizeMismatch) 494 }< span class ="kw "> else</ span > { 495< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > { (bytes.as_ptr()< span class ="kw "> as</ span >< span class ="kw-2 "> *const</ span > T).read_unaligned() }) 496 } 497} 498 499< span class ="doccomment "> /// Reads the slice into a `T` value. 500/// 501/// ## Panics 502/// * This is like `try_pod_read_unaligned` but will panic on failure. 503</ span >< span class ="attribute "> #[inline] 504</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > pod_read_unaligned<T: Copy>(bytes:< span class ="kw-2 "> &</ span > [u8]) -> T { 505< span class ="kw "> match</ span > try_pod_read_unaligned(bytes) { 506< span class ="prelude-val "> Ok</ span > (t) => t, 507< span class ="prelude-val "> Err</ span > (e) => something_went_wrong(< span class ="string "> "pod_read_unaligned"</ span > , e), 508 } 509} 510 511< span class ="doccomment "> /// Re-interprets `&[u8]` as `&T`. 512/// 513/// ## Failure 514/// 515/// * If the slice isn't aligned for the new type 516/// * If the slice's length isn’t exactly the size of the new type 517</ span >< span class ="attribute "> #[inline] 518</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > try_from_bytes<T: Copy>( 519 s:< span class ="kw-2 "> &</ span > [u8], 520) ->< span class ="prelude-ty "> Result</ span > << span class ="kw-2 "> &</ span > T, PodCastError> { 521< span class ="kw "> if</ span > s.len() != size_of::<T>() { 522< span class ="prelude-val "> Err</ span > (PodCastError::SizeMismatch) 523 }< span class ="kw "> else if</ span > (s.as_ptr()< span class ="kw "> as</ span > usize) % align_of::<T>() !=< span class ="number "> 0</ span > { 524< span class ="prelude-val "> Err</ span > (PodCastError::TargetAlignmentGreaterAndInputNotAligned) 525 }< span class ="kw "> else</ span > { 526< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > {< span class ="kw-2 "> &*</ span > (s.as_ptr()< span class ="kw "> as</ span >< span class ="kw-2 "> *const</ span > T) }) 527 } 528} 529 530< span class ="doccomment "> /// Re-interprets `&mut [u8]` as `&mut T`. 531/// 532/// ## Failure 533/// 534/// * If the slice isn't aligned for the new type 535/// * If the slice's length isn’t exactly the size of the new type 536</ span >< span class ="attribute "> #[inline] 537</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > try_from_bytes_mut<T: Copy>( 538 s:< span class ="kw-2 "> &mut</ span > [u8], 539) ->< span class ="prelude-ty "> Result</ span > << span class ="kw-2 "> &mut</ span > T, PodCastError> { 540< span class ="kw "> if</ span > s.len() != size_of::<T>() { 541< span class ="prelude-val "> Err</ span > (PodCastError::SizeMismatch) 542 }< span class ="kw "> else if</ span > (s.as_ptr()< span class ="kw "> as</ span > usize) % align_of::<T>() !=< span class ="number "> 0</ span > { 543< span class ="prelude-val "> Err</ span > (PodCastError::TargetAlignmentGreaterAndInputNotAligned) 544 }< span class ="kw "> else</ span > { 545< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > {< span class ="kw-2 "> &mut *</ span > (s.as_mut_ptr()< span class ="kw "> as</ span >< span class ="kw-2 "> *mut</ span > T) }) 546 } 547} 548 549< span class ="doccomment "> /// Cast `T` into `U` 550/// 551/// ## Panics 552/// 553/// * This is like [`try_cast`](try_cast), but will panic on a size mismatch. 554</ span >< span class ="attribute "> #[inline] 555</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > cast<A: Copy, B: Copy>(a: A) -> B { 556< span class ="kw "> if</ span > size_of::<A>() == size_of::<B>() { 557< span class ="kw "> unsafe</ span > {< span class ="macro "> transmute!</ span > (a) } 558 }< span class ="kw "> else</ span > { 559 something_went_wrong(< span class ="string "> "cast"</ span > , PodCastError::SizeMismatch) 560 } 561} 562 563< span class ="doccomment "> /// Cast `&mut T` into `&mut U`. 564/// 565/// ## Panics 566/// 567/// This is [`try_cast_mut`] but will panic on error. 568</ span >< span class ="attribute "> #[inline] 569</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > cast_mut<A: Copy, B: Copy>(a:< span class ="kw-2 "> &mut</ span > A) ->< span class ="kw-2 "> &mut</ span > B { 570< span class ="kw "> if</ span > size_of::<A>() == size_of::<B>() && align_of::<A>() >= align_of::<B>() { 571< span class ="comment "> // Plz mr compiler, just notice that we can't ever hit Err in this case. 572</ span >< span class ="kw "> match</ span > try_cast_mut(a) { 573< span class ="prelude-val "> Ok</ span > (b) => b, 574< span class ="prelude-val "> Err</ span > (< span class ="kw "> _</ span > ) =>< span class ="macro "> unreachable!</ span > (), 575 } 576 }< span class ="kw "> else</ span > { 577< span class ="kw "> match</ span > try_cast_mut(a) { 578< span class ="prelude-val "> Ok</ span > (b) => b, 579< span class ="prelude-val "> Err</ span > (e) => something_went_wrong(< span class ="string "> "cast_mut"</ span > , e), 580 } 581 } 582} 583 584< span class ="doccomment "> /// Cast `&T` into `&U`. 585/// 586/// ## Panics 587/// 588/// This is [`try_cast_ref`] but will panic on error. 589</ span >< span class ="attribute "> #[inline] 590</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > cast_ref<A: Copy, B: Copy>(a:< span class ="kw-2 "> &</ span > A) ->< span class ="kw-2 "> &</ span > B { 591< span class ="kw "> if</ span > size_of::<A>() == size_of::<B>() && align_of::<A>() >= align_of::<B>() { 592< span class ="comment "> // Plz mr compiler, just notice that we can't ever hit Err in this case. 593</ span >< span class ="kw "> match</ span > try_cast_ref(a) { 594< span class ="prelude-val "> Ok</ span > (b) => b, 595< span class ="prelude-val "> Err</ span > (< span class ="kw "> _</ span > ) =>< span class ="macro "> unreachable!</ span > (), 596 } 597 }< span class ="kw "> else</ span > { 598< span class ="kw "> match</ span > try_cast_ref(a) { 599< span class ="prelude-val "> Ok</ span > (b) => b, 600< span class ="prelude-val "> Err</ span > (e) => something_went_wrong(< span class ="string "> "cast_ref"</ span > , e), 601 } 602 } 603} 604 605< span class ="doccomment "> /// Cast `&[A]` into `&[B]`. 606/// 607/// ## Panics 608/// 609/// This is [`try_cast_slice`] but will panic on error. 610</ span >< span class ="attribute "> #[inline] 611</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > cast_slice<A: Copy, B: Copy>(a:< span class ="kw-2 "> &</ span > [A]) ->< span class ="kw-2 "> &</ span > [B] { 612< span class ="kw "> match</ span > try_cast_slice(a) { 613< span class ="prelude-val "> Ok</ span > (b) => b, 614< span class ="prelude-val "> Err</ span > (e) => something_went_wrong(< span class ="string "> "cast_slice"</ span > , e), 615 } 616} 617 618< span class ="doccomment "> /// Cast `&mut [T]` into `&mut [U]`. 619/// 620/// ## Panics 621/// 622/// This is [`try_cast_slice_mut`] but will panic on error. 623</ span >< span class ="attribute "> #[inline] 624</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > cast_slice_mut<A: Copy, B: Copy>(a:< span class ="kw-2 "> &mut</ span > [A]) ->< span class ="kw-2 "> &mut</ span > [B] { 625< span class ="kw "> match</ span > try_cast_slice_mut(a) { 626< span class ="prelude-val "> Ok</ span > (b) => b, 627< span class ="prelude-val "> Err</ span > (e) => something_went_wrong(< span class ="string "> "cast_slice_mut"</ span > , e), 628 } 629} 630 631< span class ="doccomment "> /// Try to cast `T` into `U`. 632/// 633/// Note that for this particular type of cast, alignment isn't a factor. The 634/// input value is semantically copied into the function and then returned to a 635/// new memory location which will have whatever the required alignment of the 636/// output type is. 637/// 638/// ## Failure 639/// 640/// * If the types don't have the same size this fails. 641</ span >< span class ="attribute "> #[inline] 642</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > try_cast<A: Copy, B: Copy>( 643 a: A, 644) ->< span class ="prelude-ty "> Result</ span > <B, PodCastError> { 645< span class ="kw "> if</ span > size_of::<A>() == size_of::<B>() { 646< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > {< span class ="macro "> transmute!</ span > (a) }) 647 }< span class ="kw "> else</ span > { 648< span class ="prelude-val "> Err</ span > (PodCastError::SizeMismatch) 649 } 650} 651 652< span class ="doccomment "> /// Try to convert a `&T` into `&U`. 653/// 654/// ## Failure 655/// 656/// * If the reference isn't aligned in the new type 657/// * If the source type and target type aren't the same size. 658</ span >< span class ="attribute "> #[inline] 659</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > try_cast_ref<A: Copy, B: Copy>( 660 a:< span class ="kw-2 "> &</ span > A, 661) ->< span class ="prelude-ty "> Result</ span > << span class ="kw-2 "> &</ span > B, PodCastError> { 662< span class ="comment "> // Note(Lokathor): everything with `align_of` and `size_of` will optimize away 663 // after monomorphization. 664</ span >< span class ="kw "> if</ span > align_of::<B>() > align_of::<A>() 665 && (a< span class ="kw "> as</ span >< span class ="kw-2 "> *const</ span > A< span class ="kw "> as</ span > usize) % align_of::<B>() !=< span class ="number "> 0 666</ span > { 667< span class ="prelude-val "> Err</ span > (PodCastError::TargetAlignmentGreaterAndInputNotAligned) 668 }< span class ="kw "> else if</ span > size_of::<B>() == size_of::<A>() { 669< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > {< span class ="kw-2 "> &*</ span > (a< span class ="kw "> as</ span >< span class ="kw-2 "> *const</ span > A< span class ="kw "> as</ span >< span class ="kw-2 "> *const</ span > B) }) 670 }< span class ="kw "> else</ span > { 671< span class ="prelude-val "> Err</ span > (PodCastError::SizeMismatch) 672 } 673} 674 675< span class ="doccomment "> /// Try to convert a `&mut T` into `&mut U`. 676/// 677/// As [`try_cast_ref`], but `mut`. 678</ span >< span class ="attribute "> #[inline] 679</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > try_cast_mut<A: Copy, B: Copy>( 680 a:< span class ="kw-2 "> &mut</ span > A, 681) ->< span class ="prelude-ty "> Result</ span > << span class ="kw-2 "> &mut</ span > B, PodCastError> { 682< span class ="comment "> // Note(Lokathor): everything with `align_of` and `size_of` will optimize away 683 // after monomorphization. 684</ span >< span class ="kw "> if</ span > align_of::<B>() > align_of::<A>() 685 && (a< span class ="kw "> as</ span >< span class ="kw-2 "> *mut</ span > A< span class ="kw "> as</ span > usize) % align_of::<B>() !=< span class ="number "> 0 686</ span > { 687< span class ="prelude-val "> Err</ span > (PodCastError::TargetAlignmentGreaterAndInputNotAligned) 688 }< span class ="kw "> else if</ span > size_of::<B>() == size_of::<A>() { 689< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > {< span class ="kw-2 "> &mut *</ span > (a< span class ="kw "> as</ span >< span class ="kw-2 "> *mut</ span > A< span class ="kw "> as</ span >< span class ="kw-2 "> *mut</ span > B) }) 690 }< span class ="kw "> else</ span > { 691< span class ="prelude-val "> Err</ span > (PodCastError::SizeMismatch) 692 } 693} 694 695< span class ="doccomment "> /// Try to convert `&[A]` into `&[B]` (possibly with a change in length). 696/// 697/// * `input.as_ptr() as usize == output.as_ptr() as usize` 698/// * `input.len() * size_of::<A>() == output.len() * size_of::<B>()` 699/// 700/// ## Failure 701/// 702/// * If the target type has a greater alignment requirement and the input slice 703/// isn't aligned. 704/// * If the target element type is a different size from the current element 705/// type, and the output slice wouldn't be a whole number of elements when 706/// accounting for the size change (eg: 3 `u16` values is 1.5 `u32` values, so 707/// that's a failure). 708/// * Similarly, you can't convert between a [ZST](https://doc.rust-lang.org/nomicon/exotic-sizes.html#zero-sized-types-zsts) 709/// and a non-ZST. 710</ span >< span class ="attribute "> #[inline] 711</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > try_cast_slice<A: Copy, B: Copy>( 712 a:< span class ="kw-2 "> &</ span > [A], 713) ->< span class ="prelude-ty "> Result</ span > << span class ="kw-2 "> &</ span > [B], PodCastError> { 714< span class ="comment "> // Note(Lokathor): everything with `align_of` and `size_of` will optimize away 715 // after monomorphization. 716</ span >< span class ="kw "> if</ span > align_of::<B>() > align_of::<A>() 717 && (a.as_ptr()< span class ="kw "> as</ span > usize) % align_of::<B>() !=< span class ="number "> 0 718</ span > { 719< span class ="prelude-val "> Err</ span > (PodCastError::TargetAlignmentGreaterAndInputNotAligned) 720 }< span class ="kw "> else if</ span > size_of::<B>() == size_of::<A>() { 721< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > { core::slice::from_raw_parts(a.as_ptr()< span class ="kw "> as</ span >< span class ="kw-2 "> *const</ span > B, a.len()) }) 722 }< span class ="kw "> else if</ span > size_of::<A>() ==< span class ="number "> 0</ span > || size_of::<B>() ==< span class ="number "> 0</ span > { 723< span class ="prelude-val "> Err</ span > (PodCastError::SizeMismatch) 724 }< span class ="kw "> else if</ span > core::mem::size_of_val(a) % size_of::<B>() ==< span class ="number "> 0</ span > { 725< span class ="kw "> let</ span > new_len = core::mem::size_of_val(a) / size_of::<B>(); 726< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > { core::slice::from_raw_parts(a.as_ptr()< span class ="kw "> as</ span >< span class ="kw-2 "> *const</ span > B, new_len) }) 727 }< span class ="kw "> else</ span > { 728< span class ="prelude-val "> Err</ span > (PodCastError::OutputSliceWouldHaveSlop) 729 } 730} 731 732< span class ="doccomment "> /// Try to convert `&mut [A]` into `&mut [B]` (possibly with a change in 733/// length). 734/// 735/// As [`try_cast_slice`], but `&mut`. 736</ span >< span class ="attribute "> #[inline] 737</ span >< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > )< span class ="kw "> unsafe fn</ span > try_cast_slice_mut<A: Copy, B: Copy>( 738 a:< span class ="kw-2 "> &mut</ span > [A], 739) ->< span class ="prelude-ty "> Result</ span > << span class ="kw-2 "> &mut</ span > [B], PodCastError> { 740< span class ="comment "> // Note(Lokathor): everything with `align_of` and `size_of` will optimize away 741 // after monomorphization. 742</ span >< span class ="kw "> if</ span > align_of::<B>() > align_of::<A>() 743 && (a.as_mut_ptr()< span class ="kw "> as</ span > usize) % align_of::<B>() !=< span class ="number "> 0 744</ span > { 745< span class ="prelude-val "> Err</ span > (PodCastError::TargetAlignmentGreaterAndInputNotAligned) 746 }< span class ="kw "> else if</ span > size_of::<B>() == size_of::<A>() { 747< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > { 748 core::slice::from_raw_parts_mut(a.as_mut_ptr()< span class ="kw "> as</ span >< span class ="kw-2 "> *mut</ span > B, a.len()) 749 }) 750 }< span class ="kw "> else if</ span > size_of::<A>() ==< span class ="number "> 0</ span > || size_of::<B>() ==< span class ="number "> 0</ span > { 751< span class ="prelude-val "> Err</ span > (PodCastError::SizeMismatch) 752 }< span class ="kw "> else if</ span > core::mem::size_of_val(a) % size_of::<B>() ==< span class ="number "> 0</ span > { 753< span class ="kw "> let</ span > new_len = core::mem::size_of_val(a) / size_of::<B>(); 754< span class ="prelude-val "> Ok</ span > (< span class ="kw "> unsafe</ span > { 755 core::slice::from_raw_parts_mut(a.as_mut_ptr()< span class ="kw "> as</ span >< span class ="kw-2 "> *mut</ span > B, new_len) 756 }) 757 }< span class ="kw "> else</ span > { 758< span class ="prelude-val "> Err</ span > (PodCastError::OutputSliceWouldHaveSlop) 759 } 760} 761</ code ></ pre ></ div > 762</ section ></ div ></ main >< div id ="rustdoc-vars "data-root-path ="../../ "data-current-crate ="bytemuck "data-themes ="ayu,dark,light "data-resource-suffix =""data-rustdoc-version ="1.66.0-nightly (4a1467723 2022-09-23) "></ div ></ body ></ html >