16 lines
5.1 KiB
HTML
16 lines
5.1 KiB
HTML
<!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="Convert `&A` into `&B` if infalliable, or fail to compile."><title>must_cast_ref in bytemuck - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bytemuck" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bytemuck/index.html">bytemuck</a><span class="version">1.21.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">must_<wbr>cast_<wbr>ref</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#failure" title="Failure">Failure</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate bytemuck</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">bytemuck</a></span><h1>Function <span class="fn">must_cast_ref</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/bytemuck/must.rs.html#67-71">Source</a> </span></div><pre class="rust item-decl"><code>pub const fn must_cast_ref<A: <a class="trait" href="trait.NoUninit.html" title="trait bytemuck::NoUninit">NoUninit</a>, B: <a class="trait" href="trait.AnyBitPattern.html" title="trait bytemuck::AnyBitPattern">AnyBitPattern</a>>(a: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.reference.html">&A</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.reference.html">&B</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Convert <code>&A</code> into <code>&B</code> if infalliable, or fail to compile.</p>
|
||
<h3 id="failure"><a class="doc-anchor" href="#failure">§</a>Failure</h3>
|
||
<ul>
|
||
<li>If the target type has a greater alignment requirement.</li>
|
||
<li>If the source type and target type aren’t the same size.</li>
|
||
</ul>
|
||
<h3 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h3>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// compiles:
|
||
</span><span class="kw">let </span>bytes: <span class="kw-2">&</span>[u8; <span class="number">2</span>] = bytemuck::must_cast_ref(<span class="kw-2">&</span><span class="number">12_u16</span>);</code></pre></div>
|
||
|
||
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="comment">// fails to compile (size mismatch):
|
||
</span><span class="kw">let </span>bytes : <span class="kw-2">&</span>[u8; <span class="number">3</span>] = bytemuck::must_cast_ref(<span class="kw-2">&</span><span class="number">12_u16</span>);</code></pre></div>
|
||
|
||
<div class="example-wrap compile_fail"><a href="#" class="tooltip" title="This example deliberately fails to compile">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="comment">// fails to compile (alignment requirements increased):
|
||
</span><span class="kw">let </span>bytes : <span class="kw-2">&</span>u16 = bytemuck::must_cast_ref(<span class="kw-2">&</span>[<span class="number">1u8</span>, <span class="number">2u8</span>]);</code></pre></div>
|
||
</div></details></section></div></main></body></html> |