9 lines
7.9 KiB
HTML
9 lines
7.9 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="Checked versions of the casting functions exposed in crate root that support `CheckedBitPattern` types."><title>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 mod"><!--[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="#">Module checked</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="#">Module checked</a></h2><h3><a href="#enums">Module Items</a></h3><ul class="block"><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</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" 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></div><h1>Module <span>checked</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#1-533">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Checked versions of the casting functions exposed in crate root
|
||
that support <a href="trait.CheckedBitPattern.html" title="trait bytemuck::checked::CheckedBitPattern"><code>CheckedBitPattern</code></a> types.</p>
|
||
</div></details><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.CheckedCastError.html" title="enum bytemuck::checked::CheckedCastError">Checked<wbr>Cast<wbr>Error</a></dt><dd>The things that can go wrong when casting between <a href="trait.CheckedBitPattern.html" title="trait bytemuck::checked::CheckedBitPattern"><code>CheckedBitPattern</code></a> data
|
||
forms.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.CheckedBitPattern.html" title="trait bytemuck::checked::CheckedBitPattern">Checked<wbr>BitPattern</a></dt><dd>A marker trait that allows types that have some invalid bit patterns to be
|
||
used in places that otherwise require <a href="../trait.AnyBitPattern.html" title="trait bytemuck::AnyBitPattern"><code>AnyBitPattern</code></a> or <a href="../trait.Pod.html" title="trait bytemuck::Pod"><code>Pod</code></a> types by
|
||
performing a runtime check on a perticular set of bits. This is particularly
|
||
useful for types like fieldless (‘C-style’) enums, <a href="https://doc.rust-lang.org/1.93.1/core/primitive.char.html" title="primitive char"><code>char</code></a>, bool, and
|
||
structs containing them.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.cast.html" title="fn bytemuck::checked::cast">cast</a></dt><dd>Cast <code>A</code> into <code>B</code></dd><dt><a class="fn" href="fn.cast_mut.html" title="fn bytemuck::checked::cast_mut">cast_<wbr>mut</a></dt><dd>Cast <code>&mut A</code> into <code>&mut B</code>.</dd><dt><a class="fn" href="fn.cast_ref.html" title="fn bytemuck::checked::cast_ref">cast_<wbr>ref</a></dt><dd>Cast <code>&A</code> into <code>&B</code>.</dd><dt><a class="fn" href="fn.cast_slice.html" title="fn bytemuck::checked::cast_slice">cast_<wbr>slice</a></dt><dd>Cast <code>&[A]</code> into <code>&[B]</code>.</dd><dt><a class="fn" href="fn.cast_slice_mut.html" title="fn bytemuck::checked::cast_slice_mut">cast_<wbr>slice_<wbr>mut</a></dt><dd>Cast <code>&mut [A]</code> into <code>&mut [B]</code>.</dd><dt><a class="fn" href="fn.from_bytes.html" title="fn bytemuck::checked::from_bytes">from_<wbr>bytes</a></dt><dd>Re-interprets <code>&[u8]</code> as <code>&T</code>.</dd><dt><a class="fn" href="fn.from_bytes_mut.html" title="fn bytemuck::checked::from_bytes_mut">from_<wbr>bytes_<wbr>mut</a></dt><dd>Re-interprets <code>&mut [u8]</code> as <code>&mut T</code>.</dd><dt><a class="fn" href="fn.pod_read_unaligned.html" title="fn bytemuck::checked::pod_read_unaligned">pod_<wbr>read_<wbr>unaligned</a></dt><dd>Reads the slice into a <code>T</code> value.</dd><dt><a class="fn" href="fn.try_cast.html" title="fn bytemuck::checked::try_cast">try_<wbr>cast</a></dt><dd>Try to cast <code>A</code> into <code>B</code>.</dd><dt><a class="fn" href="fn.try_cast_mut.html" title="fn bytemuck::checked::try_cast_mut">try_<wbr>cast_<wbr>mut</a></dt><dd>Try to convert a <code>&mut A</code> into <code>&mut B</code>.</dd><dt><a class="fn" href="fn.try_cast_ref.html" title="fn bytemuck::checked::try_cast_ref">try_<wbr>cast_<wbr>ref</a></dt><dd>Try to convert a <code>&A</code> into <code>&B</code>.</dd><dt><a class="fn" href="fn.try_cast_slice.html" title="fn bytemuck::checked::try_cast_slice">try_<wbr>cast_<wbr>slice</a></dt><dd>Try to convert <code>&[A]</code> into <code>&[B]</code> (possibly with a change in length).</dd><dt><a class="fn" href="fn.try_cast_slice_mut.html" title="fn bytemuck::checked::try_cast_slice_mut">try_<wbr>cast_<wbr>slice_<wbr>mut</a></dt><dd>Try to convert <code>&mut [A]</code> into <code>&mut [B]</code> (possibly with a change in
|
||
length).</dd><dt><a class="fn" href="fn.try_from_bytes.html" title="fn bytemuck::checked::try_from_bytes">try_<wbr>from_<wbr>bytes</a></dt><dd>Re-interprets <code>&[u8]</code> as <code>&T</code>.</dd><dt><a class="fn" href="fn.try_from_bytes_mut.html" title="fn bytemuck::checked::try_from_bytes_mut">try_<wbr>from_<wbr>bytes_<wbr>mut</a></dt><dd>Re-interprets <code>&mut [u8]</code> as <code>&mut T</code>.</dd><dt><a class="fn" href="fn.try_pod_read_unaligned.html" title="fn bytemuck::checked::try_pod_read_unaligned">try_<wbr>pod_<wbr>read_<wbr>unaligned</a></dt><dd>Reads from the bytes as if they were a <code>T</code>.</dd></dl></section></div></main></body></html> |