Files
rust-gpu/api/spirv_std/trait.Integer.html
2026-04-17 14:18:32 +00:00

10 lines
18 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="Abstract trait representing any SPIR-V integer type."><title>Integer in spirv_std - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="spirv_std" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (02c7f9bec 2026-04-10)" data-channel="nightly" data-search-js="search-b5634cc7.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../static.files/storage-41dd4d93.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-f7c3ffd8.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 trait"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[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="#">Integer</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../spirv_std/index.html">spirv_<wbr>std</a><span class="version">0.10.0-alpha.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Integer</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#safety" title="Safety">Safety</a></li></ul><h3><a href="#required-associated-consts">Required Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.SIGNED" title="SIGNED">SIGNED</a></li><li><a href="#associatedconstant.WIDTH" title="WIDTH">WIDTH</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Integer-for-i8" title="i8">i8</a></li><li><a href="#impl-Integer-for-i16" title="i16">i16</a></li><li><a href="#impl-Integer-for-i32" title="i32">i32</a></li><li><a href="#impl-Integer-for-i64" title="i64">i64</a></li><li><a href="#impl-Integer-for-u8" title="u8">u8</a></li><li><a href="#impl-Integer-for-u16" title="u16">u16</a></li><li><a href="#impl-Integer-for-u32" title="u32">u32</a></li><li><a href="#impl-Integer-for-u64" title="u64">u64</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate spirv_<wbr>std</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" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">spirv_std</a></div><h1>Trait <span class="trait">Integer</span>&nbsp;<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/spirv_std/scalar.rs.html#30-35">Source</a> </span></div><pre class="rust item-decl"><code>pub unsafe trait Integer: <a class="trait" href="../num_traits/int/trait.PrimInt.html" title="trait num_traits::int::PrimInt">PrimInt</a> + <a class="trait" href="trait.Number.html" title="trait spirv_std::Number">Number</a> {
const <a href="#associatedconstant.WIDTH" class="constant">WIDTH</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
const <a href="#associatedconstant.SIGNED" class="constant">SIGNED</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Abstract trait representing any SPIR-V integer type.</p>
<h2 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h2>
<p>Implementing this trait on non-primitive-integer types breaks assumptions of other unsafe code,
and should not be done.</p>
</div></details><h2 id="required-associated-consts" class="section-header">Required Associated Constants<a href="#required-associated-consts" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedconstant.WIDTH" class="method"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#32">Source</a><h4 class="code-header">const <a href="#associatedconstant.WIDTH" class="constant">WIDTH</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Width of the integer, in bits.</p>
</div></details><details class="toggle" open><summary><section id="associatedconstant.SIGNED" class="method"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#34">Source</a><h4 class="code-header">const <a href="#associatedconstant.SIGNED" class="constant">SIGNED</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>If the integer is signed: true means signed, false means unsigned.</p>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-Integer-for-i8" class="impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#impl-Integer-for-i8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Integer.html" title="trait spirv_std::Integer">Integer</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.WIDTH-1" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.WIDTH-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.WIDTH" class="constant">WIDTH</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="associatedconstant.SIGNED-1" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.SIGNED-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.SIGNED" class="constant">SIGNED</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> = true</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Integer-for-i16" class="impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#impl-Integer-for-i16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Integer.html" title="trait spirv_std::Integer">Integer</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.WIDTH-2" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.WIDTH-2" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.WIDTH" class="constant">WIDTH</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="associatedconstant.SIGNED-2" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.SIGNED-2" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.SIGNED" class="constant">SIGNED</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> = true</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Integer-for-i32" class="impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#impl-Integer-for-i32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Integer.html" title="trait spirv_std::Integer">Integer</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.WIDTH-3" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.WIDTH-3" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.WIDTH" class="constant">WIDTH</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="associatedconstant.SIGNED-3" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.SIGNED-3" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.SIGNED" class="constant">SIGNED</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> = true</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Integer-for-i64" class="impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#impl-Integer-for-i64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Integer.html" title="trait spirv_std::Integer">Integer</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.WIDTH-4" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.WIDTH-4" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.WIDTH" class="constant">WIDTH</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="associatedconstant.SIGNED-4" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.SIGNED-4" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.SIGNED" class="constant">SIGNED</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> = true</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Integer-for-u8" class="impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#impl-Integer-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Integer.html" title="trait spirv_std::Integer">Integer</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.WIDTH-5" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.WIDTH-5" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.WIDTH" class="constant">WIDTH</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="associatedconstant.SIGNED-5" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.SIGNED-5" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.SIGNED" class="constant">SIGNED</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> = false</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Integer-for-u16" class="impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#impl-Integer-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Integer.html" title="trait spirv_std::Integer">Integer</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.WIDTH-6" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.WIDTH-6" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.WIDTH" class="constant">WIDTH</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="associatedconstant.SIGNED-6" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.SIGNED-6" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.SIGNED" class="constant">SIGNED</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> = false</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Integer-for-u32" class="impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#impl-Integer-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Integer.html" title="trait spirv_std::Integer">Integer</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.WIDTH-7" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.WIDTH-7" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.WIDTH" class="constant">WIDTH</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="associatedconstant.SIGNED-7" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.SIGNED-7" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.SIGNED" class="constant">SIGNED</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> = false</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Integer-for-u64" class="impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#impl-Integer-for-u64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Integer.html" title="trait spirv_std::Integer">Integer</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.WIDTH-8" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.WIDTH-8" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.WIDTH" class="constant">WIDTH</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section><section id="associatedconstant.SIGNED-8" class="associatedconstant trait-impl"><a class="src rightside" href="../src/spirv_std/scalar.rs.html#107-119">Source</a><a href="#associatedconstant.SIGNED-8" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.SIGNED" class="constant">SIGNED</a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> = false</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/spirv_std/scalar/trait.Integer.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html>