| <!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."><meta name="keywords" content="rust, rustlang, rust-lang, checked"><title>bytemuck::checked - 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="../../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"><!--[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></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="#">Module checked</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><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"><a href="../../help.html">?</a></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><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">bytemuck</a>::<wbr><a class="mod" href="#">checked</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></h1><span class="out-of-band"><a class="srclink" href="../../src/bytemuck/checked.rs.html#1-527">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>Checked versions of the casting functions exposed in crate root |
| that support <a href="trait.CheckedBitPattern.html" title="CheckedBitPattern"><code>CheckedBitPattern</code></a> types.</p> |
| </div></details><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.CheckedCastError.html" title="bytemuck::checked::CheckedCastError enum">CheckedCastError</a></div><div class="item-right docblock-short">The things that can go wrong when casting between <a href="trait.CheckedBitPattern.html" title="CheckedBitPattern"><code>CheckedBitPattern</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.CheckedBitPattern.html" title="bytemuck::checked::CheckedBitPattern trait">CheckedBitPattern</a></div><div class="item-right docblock-short">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="AnyBitPattern"><code>AnyBitPattern</code></a> or <a href="../trait.Pod.html"><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/nightly/core/primitive.char.html" title="char"><code>char</code></a>, bool, and |
| structs containing them.</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.cast.html" title="bytemuck::checked::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::checked::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::checked::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::checked::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::checked::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::checked::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::checked::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_read_unaligned.html" title="bytemuck::checked::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::checked::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::checked::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::checked::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::checked::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::checked::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 |
| length).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.try_from_bytes.html" title="bytemuck::checked::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::checked::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::checked::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 (5c8bff74b 2022-10-21)" ></div></body></html> |
