RONCC
/
HPC-Tools-for-Quantum-Computing


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
							<!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="API documentation for the Rust `KernelWorkGroupInfoResult` enum in crate `ocl`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, KernelWorkGroupInfoResult">

    <title>ocl::enums::KernelWorkGroupInfoResult - Rust</title>

    <link rel="stylesheet" type="text/css" href="../../normalize.css">
    <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
    
    <link rel="stylesheet" type="text/css" href="../../dark.css">
    <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
    <script src="../../storage.js"></script>
    

    
    
</head>
<body class="rustdoc enum">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        <div class="sidebar-menu">&#9776;</div>
        
        <p class='location'>Enum KernelWorkGroupInfoResult</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.WorkGroupSize">WorkGroupSize</a><a href="#variant.CompileWorkGroupSize">CompileWorkGroupSize</a><a href="#variant.LocalMemSize">LocalMemSize</a><a href="#variant.PreferredWorkGroupSizeMultiple">PreferredWorkGroupSizeMultiple</a><a href="#variant.PrivateMemSize">PrivateMemSize</a><a href="#variant.GlobalWorkSize">GlobalWorkSize</a><a href="#variant.Empty">Empty</a><a href="#variant.Unavailable">Unavailable</a><a href="#variant.CustomBuiltinOnly">CustomBuiltinOnly</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.from_bytes">from_bytes</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Display">Display</a><a href="#impl-From%3CKernelWorkGroupInfoResult%3E">From&lt;KernelWorkGroupInfoResult&gt;</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='../index.html'>ocl</a>::<wbr><a href='index.html'>enums</a></p><script>window.sidebarCurrent = {name: 'KernelWorkGroupInfoResult', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
    </nav>

    <div class="theme-picker">
        <button id="theme-picker" aria-label="Pick another theme!">
            <img src="../../brush.svg" width="18" alt="Pick another theme!">
        </button>
        <div id="theme-choices"></div>
    </div>
    <script src="../../theme.js"></script>
    <nav class="sub">
        <form class="search-form js-only">
            <div class="search-container">
                <input class="search-input" name="search"
                       autocomplete="off"
                       placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
                       type="search">
            </div>
        </form>
    </nav>

    <section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Enum <a href='../index.html'>ocl</a>::<wbr><a href='index.html'>enums</a>::<wbr><a class="enum" href=''>KernelWorkGroupInfoResult</a></span><span class='out-of-band'><span id='render-detail'>
                   <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                       [<span class='inner'>&#x2212;</span>]
                   </a>
               </span><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1657-1667' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum KernelWorkGroupInfoResult {
    WorkGroupSize(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>),
    CompileWorkGroupSize(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>),
    LocalMemSize(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>),
    PreferredWorkGroupSizeMultiple(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>),
    PrivateMemSize(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>),
    GlobalWorkSize(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>),
    Empty(<a class="enum" href="../../ocl_core/types/enums/enum.EmptyInfoResultError.html" title="enum ocl_core::types::enums::EmptyInfoResultError">EmptyInfoResultError</a>),
    Unavailable(<a class="enum" href="../../ocl/enums/enum.Status.html" title="enum ocl::enums::Status">Status</a>),
    CustomBuiltinOnly,
}</pre><div class='docblock'><p>A kernel work group info result.</p>
</div><h2 id='variants' class='variants small-section-header'>
                   Variants<a href='#variants' class='anchor'></a></h2>
<span id="variant.WorkGroupSize" class="variant small-section-header"><a href="#variant.WorkGroupSize" class="anchor field"></a><span id='WorkGroupSize.v' class='invisible'><code>WorkGroupSize(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></span></span><span id="variant.CompileWorkGroupSize" class="variant small-section-header"><a href="#variant.CompileWorkGroupSize" class="anchor field"></a><span id='CompileWorkGroupSize.v' class='invisible'><code>CompileWorkGroupSize(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>)</code></span></span><span id="variant.LocalMemSize" class="variant small-section-header"><a href="#variant.LocalMemSize" class="anchor field"></a><span id='LocalMemSize.v' class='invisible'><code>LocalMemSize(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>)</code></span></span><span id="variant.PreferredWorkGroupSizeMultiple" class="variant small-section-header"><a href="#variant.PreferredWorkGroupSizeMultiple" class="anchor field"></a><span id='PreferredWorkGroupSizeMultiple.v' class='invisible'><code>PreferredWorkGroupSizeMultiple(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></span></span><span id="variant.PrivateMemSize" class="variant small-section-header"><a href="#variant.PrivateMemSize" class="anchor field"></a><span id='PrivateMemSize.v' class='invisible'><code>PrivateMemSize(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>)</code></span></span><span id="variant.GlobalWorkSize" class="variant small-section-header"><a href="#variant.GlobalWorkSize" class="anchor field"></a><span id='GlobalWorkSize.v' class='invisible'><code>GlobalWorkSize(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">; 3]</a>)</code></span></span><span id="variant.Empty" class="variant small-section-header"><a href="#variant.Empty" class="anchor field"></a><span id='Empty.v' class='invisible'><code>Empty(<a class="enum" href="../../ocl_core/types/enums/enum.EmptyInfoResultError.html" title="enum ocl_core::types::enums::EmptyInfoResultError">EmptyInfoResultError</a>)</code></span></span><span id="variant.Unavailable" class="variant small-section-header"><a href="#variant.Unavailable" class="anchor field"></a><span id='Unavailable.v' class='invisible'><code>Unavailable(<a class="enum" href="../../ocl/enums/enum.Status.html" title="enum ocl::enums::Status">Status</a>)</code></span></span><span id="variant.CustomBuiltinOnly" class="variant small-section-header"><a href="#variant.CustomBuiltinOnly" class="anchor field"></a><span id='CustomBuiltinOnly.v' class='invisible'><code>CustomBuiltinOnly</code></span></span>
                    <h2 id='methods' class='small-section-header'>
                      Methods<a href='#methods' class='anchor'></a>
                    </h2>
                <h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="enum" href="../../ocl/enums/enum.KernelWorkGroupInfoResult.html" title="enum ocl::enums::KernelWorkGroupInfoResult">KernelWorkGroupInfoResult</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1669-1728' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from_bytes' class="method"><span id='from_bytes.v' class='invisible'><code>pub fn <a href='#method.from_bytes' class='fnname'>from_bytes</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;request: <a class="enum" href="../../ocl/enums/enum.KernelWorkGroupInfo.html" title="enum ocl::enums::KernelWorkGroupInfo">KernelWorkGroupInfo</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;result: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../../ocl/enums/enum.KernelWorkGroupInfoResult.html" title="enum ocl::enums::KernelWorkGroupInfoResult">KernelWorkGroupInfoResult</a>, <a class="struct" href="../../ocl_core/error/struct.Error.html" title="struct ocl_core::error::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1670-1727' title='goto source code'>[src]</a></span></h4>
</div>
            <h2 id='implementations' class='small-section-header'>
              Trait Implementations<a href='#implementations' class='anchor'></a>
            </h2>
        <h3 id='impl-Display' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../../ocl/enums/enum.KernelWorkGroupInfoResult.html" title="enum ocl::enums::KernelWorkGroupInfoResult">KernelWorkGroupInfoResult</a></code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1736-1751' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1737-1750' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-From%3CKernelWorkGroupInfoResult%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="enum" href="../../ocl/enums/enum.KernelWorkGroupInfoResult.html" title="enum ocl::enums::KernelWorkGroupInfoResult">KernelWorkGroupInfoResult</a>&gt; for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code><a href='#impl-From%3CKernelWorkGroupInfoResult%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1753-1757' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(ir: <a class="enum" href="../../ocl/enums/enum.KernelWorkGroupInfoResult.html" title="enum ocl::enums::KernelWorkGroupInfoResult">KernelWorkGroupInfoResult</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1754-1756' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../ocl/enums/enum.KernelWorkGroupInfoResult.html" title="enum ocl::enums::KernelWorkGroupInfoResult">KernelWorkGroupInfoResult</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1730-1734' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/ocl_core/types/enums.rs.html#1731-1733' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div></section>
    <section id='search' class="content hidden"></section>

    <section class="footer"></section>

    <aside id="help" class="hidden">
        <div>
            <h1 class="hidden">Help</h1>

            <div class="shortcuts">
                <h2>Keyboard Shortcuts</h2>

                <dl>
                    <dt><kbd>?</kbd></dt>
                    <dd>Show this help dialog</dd>
                    <dt><kbd>S</kbd></dt>
                    <dd>Focus the search field</dd>
                    <dt><kbd>↑</kbd></dt>
                    <dd>Move up in search results</dd>
                    <dt><kbd>↓</kbd></dt>
                    <dd>Move down in search results</dd>
                    <dt><kbd>↹</kbd></dt>
                    <dd>Switch tab</dd>
                    <dt><kbd>&#9166;</kbd></dt>
                    <dd>Go to active search result</dd>
                    <dt><kbd>+</kbd></dt>
                    <dd>Expand all sections</dd>
                    <dt><kbd>-</kbd></dt>
                    <dd>Collapse all sections</dd>
                </dl>
            </div>

            <div class="infos">
                <h2>Search Tricks</h2>

                <p>
                    Prefix searches with a type followed by a colon (e.g.
                    <code>fn:</code>) to restrict the search to a given type.
                </p>

                <p>
                    Accepted types are: <code>fn</code>, <code>mod</code>,
                    <code>struct</code>, <code>enum</code>,
                    <code>trait</code>, <code>type</code>, <code>macro</code>,
                    and <code>const</code>.
                </p>

                <p>
                    Search functions by type signature (e.g.
                    <code>vec -> usize</code> or <code>* -> vec</code>)
                </p>
            </div>
        </div>
    </aside>

    

    <script>
        window.rootPath = "../../";
        window.currentCrate = "ocl";
    </script>
    <script src="../../main.js"></script>
    <script defer src="../../search-index.js"></script>
</body>
</html>