165 lines
17 KiB
HTML
165 lines
17 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="API documentation for the Rust `EnumClass` struct in crate `glib`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, EnumClass">
|
||
|
||
<title>glib::EnumClass - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../normalize.css">
|
||
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc struct">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'>Struct EnumClass</p><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.type_">type_</a><a href="#method.get_value">get_value</a><a href="#method.get_value_by_name">get_value_by_name</a><a href="#method.get_value_by_nick">get_value_by_nick</a><a href="#method.get_values">get_values</a><a href="#method.to_value">to_value</a><a href="#method.to_value_by_name">to_value_by_name</a><a href="#method.to_value_by_nick">to_value_by_nick</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Drop">Drop</a><a href="#impl-Clone">Clone</a></div></div><p class='location'><a href='index.html'>glib</a></p><script>window.sidebarCurrent = {name: 'EnumClass', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<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'>Struct <a href='index.html'>glib</a>::<wbr><a class="struct" href=''>EnumClass</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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/glib/enums.rs.html#49' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct EnumClass(_);</pre><div class='docblock'><p>Representation of an <code>enum</code> for dynamically, at runtime, querying the values of the enum and
|
||
using them.</p>
|
||
</div>
|
||
<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="struct" href="../glib/struct.EnumClass.html" title="struct glib::EnumClass">EnumClass</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#51-144' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(type_: <a class="enum" href="../glib/types/enum.Type.html" title="enum glib::types::Type">Type</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#55-64' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Create a new <code>EnumClass</code> from a <code>Type</code>.</p>
|
||
|
||
<p>Returns <code>None</code> if <code>type_</code> is not representing an enum.</p>
|
||
</div><h4 id='method.type_' class="method"><span id='type_.v' class='invisible'><code>pub fn <a href='#method.type_' class='fnname'>type_</a>(&self) -> <a class="enum" href="../glib/types/enum.Type.html" title="enum glib::types::Type">Type</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#67-71' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p><code>Type</code> of the enum.</p>
|
||
</div><h4 id='method.get_value' class="method"><span id='get_value.v' class='invisible'><code>pub fn <a href='#method.get_value' class='fnname'>get_value</a>(&self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../glib/struct.EnumValue.html" title="struct glib::EnumValue">EnumValue</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#77-86' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Gets <code>EnumValue</code> by integer <code>value</code>, if existing.</p>
|
||
|
||
<p>Returns <code>None</code> if the enum does not contain any value
|
||
with <code>value</code>.</p>
|
||
</div><h4 id='method.get_value_by_name' class="method"><span id='get_value_by_name.v' class='invisible'><code>pub fn <a href='#method.get_value_by_name' class='fnname'>get_value_by_name</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../glib/struct.EnumValue.html" title="struct glib::EnumValue">EnumValue</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#92-101' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Gets <code>EnumValue</code> by string name <code>name</code>, if existing.</p>
|
||
|
||
<p>Returns <code>None</code> if the enum does not contain any value
|
||
with name <code>name</code>.</p>
|
||
</div><h4 id='method.get_value_by_nick' class="method"><span id='get_value_by_nick.v' class='invisible'><code>pub fn <a href='#method.get_value_by_nick' class='fnname'>get_value_by_nick</a>(&self, nick: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../glib/struct.EnumValue.html" title="struct glib::EnumValue">EnumValue</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#107-116' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Gets <code>EnumValue</code> by string nick <code>nick</code>, if existing.</p>
|
||
|
||
<p>Returns <code>None</code> if the enum does not contain any value
|
||
with nick <code>nick</code>.</p>
|
||
</div><h4 id='method.get_values' class="method"><span id='get_values.v' class='invisible'><code>pub fn <a href='#method.get_values' class='fnname'>get_values</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../glib/struct.EnumValue.html" title="struct glib::EnumValue">EnumValue</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#119-128' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Gets all <code>EnumValue</code> of this <code>EnumClass</code>.</p>
|
||
</div><h4 id='method.to_value' class="method"><span id='to_value.v' class='invisible'><code>pub fn <a href='#method.to_value' class='fnname'>to_value</a>(&self, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../glib/value/struct.Value.html" title="struct glib::value::Value">Value</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#131-133' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Converts integer <code>value</code> to a <code>Value</code>, if part of the enum.</p>
|
||
</div><h4 id='method.to_value_by_name' class="method"><span id='to_value_by_name.v' class='invisible'><code>pub fn <a href='#method.to_value_by_name' class='fnname'>to_value_by_name</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../glib/value/struct.Value.html" title="struct glib::value::Value">Value</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#136-138' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Converts string name <code>name</code> to a <code>Value</code>, if part of the enum.</p>
|
||
</div><h4 id='method.to_value_by_nick' class="method"><span id='to_value_by_nick.v' class='invisible'><code>pub fn <a href='#method.to_value_by_nick' class='fnname'>to_value_by_nick</a>(&self, nick: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../glib/value/struct.Value.html" title="struct glib::value::Value">Value</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#141-143' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Converts string nick <code>nick</code> to a <code>Value</code>, if part of the enum.</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<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="struct" href="../glib/struct.EnumClass.html" title="struct glib::EnumClass">EnumClass</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#48' 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.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#48' 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><h3 id='impl-Drop' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../glib/struct.EnumClass.html" title="struct glib::EnumClass">EnumClass</a></code><a href='#impl-Drop' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#146-152' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#147-151' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../glib/struct.EnumClass.html" title="struct glib::EnumClass">EnumClass</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#154-160' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glib/enums.rs.html#155-159' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>↑</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>↓</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>↹</dt>
|
||
<dd>Switch tab</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt style="width:31px;">+ / -</dt>
|
||
<dd>Collapse/expand 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 = "glib";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |