+/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 ="This crate gives small utilities for casting between plain data types. ">< meta name ="keywords "content ="rust, rustlang, rust-lang, bytemuck ">< title > bytemuck - 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 ="../crates.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 mod crate "> <!--[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 >< h2 class ="location ">< a href ="# "> Crate bytemuck</ a ></ h2 >< div class ="sidebar-elems ">< div class ="block ">< ul >< li class ="version "> Version 1.12.1</ li >< li >< a id ="all-types "href ="all.html "> All Items</ a ></ li ></ ul ></ div >< section >< div class ="block ">< ul >< li >< a href ="#reexports "> Re-exports</ a ></ li >< li >< a href ="#modules "> Modules</ a ></ li >< li >< a href ="#macros "> Macros</ a ></ li >< li >< a href ="#enums "> Enums</ a ></ li >< li >< a href ="#traits "> Traits</ a ></ li >< li >< a href ="#functions "> Functions</ a ></ li ></ ul ></ div ></ section ></ div ></ 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 ="main-heading ">< h1 class ="fqn ">< span class ="in-band "> Crate< a class ="mod "href ="# "> bytemuck</ 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/bytemuck/lib.rs.html#1-385 "> source</ a > ·< a id ="toggle-all-docs "href ="javascript:void(0) "title ="collapse all docs "> [< span class ="inner "> −</ span > ]</ a ></ span ></ div >< details class ="rustdoc-toggle top-doc "open >< summary class ="hideme ">< span > Expand description</ span ></ summary >< div class ="docblock ">< p > This crate gives small utilities for casting between plain data types.</ p > 2< h3 id ="basics ">< a href ="#basics "> Basics</ a ></ h3 > 3< p > Data comes in five basic forms in Rust, so we have five basic casting 4functions:</ p > 5< ul > 6< li >< code > T</ code > uses< a href ="fn.cast.html "title ="cast ">< code > cast</ code ></ a ></ li > 7< li >< code > &T</ code > uses< a href ="fn.cast_ref.html "title ="cast_ref ">< code > cast_ref</ code ></ a ></ li > 8< li >< code > &mut T</ code > uses< a href ="fn.cast_mut.html "title ="cast_mut ">< code > cast_mut</ code ></ a ></ li > 9< li >< code > &[T]</ code > uses< a href ="fn.cast_slice.html "title ="cast_slice ">< code > cast_slice</ code ></ a ></ li > 10< li >< code > &mut [T]</ code > uses< a href ="fn.cast_slice_mut.html "title ="cast_slice_mut ">< code > cast_slice_mut</ code ></ a ></ li > 11</ ul > 12< p > Some casts will never fail (eg:< code > cast::<u32, f32></ code > always works), other 13casts might fail (eg:< code > cast_ref::<[u8; 4], u32></ code > will fail if the reference 14isn’t already aligned to 4). Each casting function has a “try” version which 15will return a< code > Result</ code > , and the “normal” version which will simply panic on 16invalid input.</ p > 17< h3 id ="using-your-own-types ">< a href ="#using-your-own-types "> Using Your Own Types</ a ></ h3 > 18< p > All the functions here are guarded by the< a href ="trait.Pod.html "title ="Pod ">< code > Pod</ code ></ a > trait, which is a 19sub-trait of the< a href ="trait.Zeroable.html "title ="Zeroable ">< code > Zeroable</ code ></ a > trait.</ p > 20< p > If you’re very sure that your type is eligible, you can implement those 21traits for your type and then they’ll have full casting support. However, 22these traits are< code > unsafe</ code > , and you should carefully read the requirements 23before adding the them to your own types.</ p > 24< h3 id ="features ">< a href ="#features "> Features</ a ></ h3 > 25< ul > 26< li > This crate is core only by default, but if you’re using Rust 1.36 or later 27you can enable the< code > extern_crate_alloc</ code > cargo feature for some additional 28methods related to< code > Box</ code > and< code > Vec</ code > . Note that the< code > docs.rs</ code > documentation 29is always built with< code > extern_crate_alloc</ code > cargo feature enabled.</ li > 30</ ul > 31</ div ></ details >< h2 id ="reexports "class ="small-section-header ">< a href ="#reexports "> Re-exports</ a ></ h2 >< div class ="item-table ">< div class ="item-row ">< div class ="item-left import-item "id ="reexport.CheckedBitPattern ">< code > pub use checked::< a class ="trait "href ="checked/trait.CheckedBitPattern.html "title ="trait bytemuck::checked::CheckedBitPattern "> CheckedBitPattern</ a > ;</ code ></ div ></ div ></ div >< h2 id ="modules "class ="small-section-header ">< a href ="#modules "> Modules</ a ></ h2 >< div class ="item-table ">< div class ="item-row ">< div class ="item-left module-item ">< a class ="mod "href ="checked/index.html "title ="bytemuck::checked mod "> checked</ a ></ div >< div class ="item-right docblock-short "> Checked versions of the casting functions exposed in crate root 32that support< a href ="checked/trait.CheckedBitPattern.html "title ="CheckedBitPattern ">< code > CheckedBitPattern</ code ></ a > types.</ div ></ div ></ div >< h2 id ="macros "class ="small-section-header ">< a href ="#macros "> Macros</ a ></ h2 >< div class ="item-table ">< div class ="item-row ">< div class ="item-left module-item ">< a class ="macro "href ="macro.offset_of.html "title ="bytemuck::offset_of macro "> offset_of</ a ></ div >< div class ="item-right docblock-short "> Find the offset in bytes of the given< code > $field</ code > of< code > $Type</ code > . Requires an 33already initialized< code > $instance</ code > value to work with.</ div ></ div ></ div >< h2 id ="enums "class ="small-section-header ">< a href ="#enums "> Enums</ a ></ h2 >< div class ="item-table ">< div class ="item-row ">< div class ="item-left module-item ">< a class ="enum "href ="enum.PodCastError.html "title ="bytemuck::PodCastError enum "> PodCastError</ a ></ div >< div class ="item-right docblock-short "> The things that can go wrong when casting between< a href ="trait.Pod.html "title ="Pod ">< code > Pod</ code ></ a > data forms.</ div ></ div ></ div >< h2 id ="traits "class ="small-section-header ">< a href ="#traits "> Traits</ a ></ h2 >< div class ="item-table ">< div class ="item-row ">< div class ="item-left module-item ">< a class ="trait "href ="trait.AnyBitPattern.html "title ="bytemuck::AnyBitPattern trait "> AnyBitPattern</ a ></ div >< div class ="item-right docblock-short "> Marker trait for “plain old data” types that are valid for any bit pattern.</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="trait "href ="trait.Contiguous.html "title ="bytemuck::Contiguous trait "> Contiguous</ a ></ div >< div class ="item-right docblock-short "> A trait indicating that:</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="trait "href ="trait.NoUninit.html "title ="bytemuck::NoUninit trait "> NoUninit</ a ></ div >< div class ="item-right docblock-short "> Marker trait for “plain old data” types with no uninit (or padding) bytes.</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="trait "href ="trait.Pod.html "title ="bytemuck::Pod trait "> Pod</ a ></ div >< div class ="item-right docblock-short "> Marker trait for “plain old data”.</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="trait "href ="trait.PodInOption.html "title ="bytemuck::PodInOption trait "> PodInOption</ a ></ div >< div class ="item-right docblock-short "> Trait for types which are< a href ="trait.Pod.html "> Pod</ a > when wrapped in 34< a href ="https://doc.rust-lang.org/nightly/core/option/enum.Option.html "> Option</ a > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="trait "href ="trait.TransparentWrapper.html "title ="bytemuck::TransparentWrapper trait "> TransparentWrapper</ a ></ div >< div class ="item-right docblock-short "> A trait which indicates that a type is a< code > #[repr(transparent)]</ code > wrapper 35around the< code > Inner</ code > value.</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="trait "href ="trait.Zeroable.html "title ="bytemuck::Zeroable trait "> Zeroable</ a ></ div >< div class ="item-right docblock-short "> Trait for types that can be safely created with 36< a href ="https://doc.rust-lang.org/nightly/core/mem/fn.zeroed.html ">< code > zeroed</ code ></ a > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="trait "href ="trait.ZeroableInOption.html "title ="bytemuck::ZeroableInOption trait "> ZeroableInOption</ a ></ div >< div class ="item-right docblock-short "> Trait for types which are< a href ="trait.Zeroable.html "> Zeroable</ a > when wrapped in 37< a href ="https://doc.rust-lang.org/nightly/core/option/enum.Option.html "> Option</ a > .</ div ></ div ></ div >< h2 id ="functions "class ="small-section-header ">< a href ="#functions "> Functions</ a ></ h2 >< div class ="item-table ">< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.bytes_of.html "title ="bytemuck::bytes_of fn "> bytes_of</ a ></ div >< div class ="item-right docblock-short "> Re-interprets< code > &T</ code > as< code > &[u8]</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.bytes_of_mut.html "title ="bytemuck::bytes_of_mut fn "> bytes_of_mut</ a ></ div >< div class ="item-right docblock-short "> Re-interprets< code > &mut T</ code > as< code > &mut [u8]</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.cast.html "title ="bytemuck::cast fn "> cast</ a ></ div >< div class ="item-right docblock-short "> Cast< code > T</ code > into< code > U</ code ></ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.cast_mut.html "title ="bytemuck::cast_mut fn "> cast_mut</ a ></ div >< div class ="item-right docblock-short "> Cast< code > &mut T</ code > into< code > &mut U</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.cast_ref.html "title ="bytemuck::cast_ref fn "> cast_ref</ a ></ div >< div class ="item-right docblock-short "> Cast< code > &T</ code > into< code > &U</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.cast_slice.html "title ="bytemuck::cast_slice fn "> cast_slice</ a ></ div >< div class ="item-right docblock-short "> Cast< code > &[A]</ code > into< code > &[B]</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.cast_slice_mut.html "title ="bytemuck::cast_slice_mut fn "> cast_slice_mut</ a ></ div >< div class ="item-right docblock-short "> Cast< code > &mut [T]</ code > into< code > &mut [U]</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.from_bytes.html "title ="bytemuck::from_bytes fn "> from_bytes</ a ></ div >< div class ="item-right docblock-short "> Re-interprets< code > &[u8]</ code > as< code > &T</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.from_bytes_mut.html "title ="bytemuck::from_bytes_mut fn "> from_bytes_mut</ a ></ div >< div class ="item-right docblock-short "> Re-interprets< code > &mut [u8]</ code > as< code > &mut T</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.pod_align_to.html "title ="bytemuck::pod_align_to fn "> pod_align_to</ a ></ div >< div class ="item-right docblock-short "> As< code > align_to</ code > , but safe because of the< a href ="trait.Pod.html "title ="Pod ">< code > Pod</ code ></ a > bound.</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.pod_align_to_mut.html "title ="bytemuck::pod_align_to_mut fn "> pod_align_to_mut</ a ></ div >< div class ="item-right docblock-short "> As< code > align_to_mut</ code > , but safe because of the< a href ="trait.Pod.html "title ="Pod ">< code > Pod</ code ></ a > bound.</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.pod_read_unaligned.html "title ="bytemuck::pod_read_unaligned fn "> pod_read_unaligned</ a ></ div >< div class ="item-right docblock-short "> Reads the slice into a< code > T</ code > value.</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.try_cast.html "title ="bytemuck::try_cast fn "> try_cast</ a ></ div >< div class ="item-right docblock-short "> Try to cast< code > T</ code > into< code > U</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.try_cast_mut.html "title ="bytemuck::try_cast_mut fn "> try_cast_mut</ a ></ div >< div class ="item-right docblock-short "> Try to convert a< code > &mut T</ code > into< code > &mut U</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.try_cast_ref.html "title ="bytemuck::try_cast_ref fn "> try_cast_ref</ a ></ div >< div class ="item-right docblock-short "> Try to convert a< code > &T</ code > into< code > &U</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.try_cast_slice.html "title ="bytemuck::try_cast_slice fn "> try_cast_slice</ a ></ div >< div class ="item-right docblock-short "> Try to convert< code > &[A]</ code > into< code > &[B]</ code > (possibly with a change in length).</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.try_cast_slice_mut.html "title ="bytemuck::try_cast_slice_mut fn "> try_cast_slice_mut</ a ></ div >< div class ="item-right docblock-short "> Try to convert< code > &mut [A]</ code > into< code > &mut [B]</ code > (possibly with a change in 38length).</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.try_from_bytes.html "title ="bytemuck::try_from_bytes fn "> try_from_bytes</ a ></ div >< div class ="item-right docblock-short "> Re-interprets< code > &[u8]</ code > as< code > &T</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.try_from_bytes_mut.html "title ="bytemuck::try_from_bytes_mut fn "> try_from_bytes_mut</ a ></ div >< div class ="item-right docblock-short "> Re-interprets< code > &mut [u8]</ code > as< code > &mut T</ code > .</ div ></ div >< div class ="item-row ">< div class ="item-left module-item ">< a class ="fn "href ="fn.try_pod_read_unaligned.html "title ="bytemuck::try_pod_read_unaligned fn "> try_pod_read_unaligned</ a ></ div >< div class ="item-right docblock-short "> Reads from the bytes as if they were a< code > T</ code > .</ div ></ div ></ div ></ 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 >