19 lines
4.8 KiB
HTML
19 lines
4.8 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="Try to convert `&[A]` into `&[B]` (possibly with a change in length)."><title>try_cast_slice in bytemuck::checked - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.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]--><rustdoc-topbar><h2><a href="#">try_cast_slice</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../bytemuck/index.html">bytemuck</a><span class="version">1.25.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">try_<wbr>cast_<wbr>slice</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#failure" title="Failure">Failure</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In bytemuck::<wbr>checked</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">bytemuck</a>::<wbr><a href="index.html">checked</a></div><h1>Function <span class="fn">try_<wbr>cast_<wbr>slice</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/checked.rs.html#378-390">Source</a> </span></div><pre class="rust item-decl"><code>pub fn try_cast_slice<A: <a class="trait" href="../trait.NoUninit.html" title="trait bytemuck::NoUninit">NoUninit</a>, B: <a class="trait" href="trait.CheckedBitPattern.html" title="trait bytemuck::checked::CheckedBitPattern">CheckedBitPattern</a>>(
|
||
a: &<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.slice.html">[A]</a>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.slice.html">[B]</a>, <a class="enum" href="enum.CheckedCastError.html" title="enum bytemuck::checked::CheckedCastError">CheckedCastError</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Try to convert <code>&[A]</code> into <code>&[B]</code> (possibly with a change in length).</p>
|
||
<ul>
|
||
<li><code>input.as_ptr() as usize == output.as_ptr() as usize</code></li>
|
||
<li><code>input.len() * size_of::<A>() == output.len() * size_of::<B>()</code></li>
|
||
</ul>
|
||
<h3 id="failure"><a class="doc-anchor" href="#failure">§</a>Failure</h3>
|
||
<ul>
|
||
<li>If the target type has a greater alignment requirement and the input slice
|
||
isn’t aligned.</li>
|
||
<li>If the target element type is a different size from the current element
|
||
type, and the output slice wouldn’t be a whole number of elements when
|
||
accounting for the size change (eg: 3 <code>u16</code> values is 1.5 <code>u32</code> values, so
|
||
that’s a failure).</li>
|
||
<li>If any element of the converted slice would contain an invalid bit pattern
|
||
for <code>B</code> this fails.</li>
|
||
</ul>
|
||
</div></details></section></div></main></body></html> |