<!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 `Builder` struct in crate `alacritty`."><meta name="keywords" content="rust, rustlang, rust-lang, Builder"><title>alacritty::util::thread::Builder - 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="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></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"><div class="sidebar-menu">☰</div><a href='../../../alacritty/index.html'><img src='../../../rust-logo.png' alt='logo' width='100'></a><p class='location'>Struct Builder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.name">name</a><a href="#method.new">new</a><a href="#method.spawn">spawn</a><a href="#method.spawn_unchecked">spawn_unchecked</a><a href="#method.stack_size">stack_size</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow">Borrow</a><a href="#impl-BorrowMut">BorrowMut</a><a href="#impl-Erased">Erased</a><a href="#impl-From">From</a><a href="#impl-Into">Into</a><a href="#impl-SetParameter">SetParameter</a><a href="#impl-TryFrom">TryFrom</a><a href="#impl-TryInto">TryInto</a></div></div><p class='location'><a href='../../index.html'>alacritty</a>::<wbr><a href='../index.html'>util</a>::<wbr><a href='index.html'>thread</a></p><script>window.sidebarCurrent = {name: 'Builder', ty: 'struct', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><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='https://doc.rust-lang.org/nightly/src/std/thread/mod.rs.html#254-259' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../../index.html'>alacritty</a>::<wbr><a href='../index.html'>util</a>::<wbr><a href='index.html'>thread</a>::<wbr><a class="struct" href=''>Builder</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct Builder { /* fields omitted */ }</pre></div><div class='docblock'><p>Thread factory, which can be used in order to configure the properties of
a new thread.</p>
<p>Methods can be chained on it in order to configure it.</p>
<p>The two configurations available are:</p>
<ul>
<li><a href="../../std/thread/struct.Builder.html#method.name"><code>name</code></a>: specifies an <a href="./index.html#naming-threads">associated name for the thread</a></li>
<li><a href="../../std/thread/struct.Builder.html#method.stack_size"><code>stack_size</code></a>: specifies the <a href="./index.html#stack-size">desired stack size for the thread</a></li>
</ul>
<p>The <a href="../../std/thread/struct.Builder.html#method.spawn"><code>spawn</code></a> method will take ownership of the builder and create an
<a href="../../std/io/type.Result.html"><code>io::Result</code></a> to the thread handle with the given configuration.</p>
<p>The <a href="../../std/thread/fn.spawn.html"><code>thread::spawn</code></a> free function uses a <code>Builder</code> with default
configuration and <a href="../../std/result/enum.Result.html#method.unwrap"><code>unwrap</code></a>s its return value.</p>
<p>You may want to use <a href="../../std/thread/struct.Builder.html#method.spawn"><code>spawn</code></a> instead of <a href="../../std/thread/fn.spawn.html"><code>thread::spawn</code></a>, when you want
to recover from a failure to launch a thread, indeed the free function will
panic where the <code>Builder</code> method will return a <a href="../../std/io/type.Result.html"><code>io::Result</code></a>.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="kw">let</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">Builder</span>::<span class="ident">new</span>();
<span class="kw">let</span> <span class="ident">handler</span> <span class="op">=</span> <span class="ident">builder</span>.<span class="ident">spawn</span>(<span class="op">||</span> {
<span class="comment">// thread code</span>
}).<span class="ident">unwrap</span>();
<span class="ident">handler</span>.<span class="ident">join</span>().<span class="ident">unwrap</span>();</pre></div>
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../../../alacritty/util/thread/struct.Builder.html" title="struct alacritty::util::thread::Builder">Builder</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/thread/mod.rs.html#261-496' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../../../alacritty/util/thread/struct.Builder.html" title="struct alacritty::util::thread::Builder">Builder</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/thread/mod.rs.html#281-286' title='goto source code'>[src]</a></h4><div class='docblock'><p>Generates the base configuration for spawning a thread, from which
configuration methods can be chained.</p>
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="kw">let</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">Builder</span>::<span class="ident">new</span>()
.<span class="ident">name</span>(<span class="string">"foo"</span>.<span class="ident">into</span>())
.<span class="ident">stack_size</span>(<span class="number">10</span>);
<span class="kw">let</span> <span class="ident">handler</span> <span class="op">=</span> <span class="ident">builder</span>.<span class="ident">spawn</span>(<span class="op">||</span> {
<span class="comment">// thread code</span>
}).<span class="ident">unwrap</span>();
<span class="ident">handler</span>.<span class="ident">join</span>().<span class="ident">unwrap</span>();</pre></div>
</div><h4 id='method.name' class="method"><code id='name.v'>pub fn <a href='#method.name' class='fnname'>name</a>(self, name: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> <a class="struct" href="../../../alacritty/util/thread/struct.Builder.html" title="struct alacritty::util::thread::Builder">Builder</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/thread/mod.rs.html#313-316' title='goto source code'>[src]</a></h4><div class='docblock'><p>Names the thread-to-be. Currently the name is used for identification
only in panic messages.</p>
<p>The name must not contain null bytes (<code>\0</code>).</p>
<p>For more information about named threads, see
<a href="./index.html#naming-threads">this module-level documentation</a>.</p>
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="kw">let</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">Builder</span>::<span class="ident">new</span>()
.<span class="ident">name</span>(<span class="string">"foo"</span>.<span class="ident">into</span>());
<span class="kw">let</span> <span class="ident">handler</span> <span class="op">=</span> <span class="ident">builder</span>.<span class="ident">spawn</span>(<span class="op">||</span> {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">thread</span>::<span class="ident">current</span>().<span class="ident">name</span>(), <span class="prelude-val">Some</span>(<span class="string">"foo"</span>))
}).<span class="ident">unwrap</span>();
<span class="ident">handler</span>.<span class="ident">join</span>().<span class="ident">unwrap</span>();</pre></div>
</div><h4 id='method.stack_size' class="method"><code id='stack_size.v'>pub fn <a href='#method.stack_size' class='fnname'>stack_size</a>(self, size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../../alacritty/util/thread/struct.Builder.html" title="struct alacritty::util::thread::Builder">Builder</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/thread/mod.rs.html#336-339' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets the size of the stack (in bytes) for the new thread.</p>
<p>The actual stack size may be greater than this value if
the platform specifies a minimal stack size.</p>
<p>For more information about the stack size for threads, see
<a href="./index.html#stack-size">this module-level documentation</a>.</p>
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="kw">let</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">Builder</span>::<span class="ident">new</span>().<span class="ident">stack_size</span>(<span class="number">32</span> <span class="op">*</span> <span class="number">1024</span>);</pre></div>
</div><h4 id='method.spawn' class="method"><code id='spawn.v'>pub fn <a href='#method.spawn' class='fnname'>spawn</a><F, T>(self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../../alacritty/util/thread/struct.JoinHandle.html" title="struct alacritty::util::thread::JoinHandle">JoinHandle</a><T>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> T + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/thread/mod.rs.html#379-383' title='goto source code'>[src]</a></h4><div class='docblock'><p>Spawns a new thread by taking ownership of the <code>Builder</code>, and returns an
<a href="../../std/io/type.Result.html"><code>io::Result</code></a> to its <a href="../../std/thread/struct.JoinHandle.html"><code>JoinHandle</code></a>.</p>
<p>The spawned thread may outlive the caller (unless the caller thread
is the main thread; the whole process is terminated when the main
thread finishes). The join handle can be used to block on
termination of the child thread, including recovering its panics.</p>
<p>For a more complete documentation see <a href="../../std/thread/fn.spawn.html"><code>thread::spawn</code></a>.</p>
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
<p>Unlike the <a href="../../std/thread/fn.spawn.html"><code>spawn</code></a> free function, this method yields an
<a href="../../std/io/type.Result.html"><code>io::Result</code></a> to capture any failure to create the thread at
the OS level.</p>
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
<p>Panics if a thread name was set and it contained null bytes.</p>
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="kw">let</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">Builder</span>::<span class="ident">new</span>();
<span class="kw">let</span> <span class="ident">handler</span> <span class="op">=</span> <span class="ident">builder</span>.<span class="ident">spawn</span>(<span class="op">||</span> {
<span class="comment">// thread code</span>
}).<span class="ident">unwrap</span>();
<span class="ident">handler</span>.<span class="ident">join</span>().<span class="ident">unwrap</span>();</pre></div>
</div><h4 id='method.spawn_unchecked' class="method"><code id='spawn_unchecked.v'>pub unsafe fn <a href='#method.spawn_unchecked' class='fnname'>spawn_unchecked</a><'a, F, T>(<br> self, <br> f: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../../alacritty/util/thread/struct.JoinHandle.html" title="struct alacritty::util::thread::JoinHandle">JoinHandle</a><T>, <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> T + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'a,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'a, </span></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/thread/mod.rs.html#447-495' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>thread_spawn_unchecked</code>)</div></div><div class='docblock'><p>Spawns a new thread without any lifetime restrictions by taking ownership
of the <code>Builder</code>, and returns an <a href="../../std/io/type.Result.html"><code>io::Result</code></a> to its <a href="../../std/thread/struct.JoinHandle.html"><code>JoinHandle</code></a>.</p>
<p>The spawned thread may outlive the caller (unless the caller thread
is the main thread; the whole process is terminated when the main
thread finishes). The join handle can be used to block on
termination of the child thread, including recovering its panics.</p>
<p>This method is identical to <a href="../../std/thread/struct.Builder.html#method.spawn"><code>thread::Builder::spawn</code></a>,
except for the relaxed lifetime bounds, which render it unsafe.
For a more complete documentation see <a href="../../std/thread/fn.spawn.html"><code>thread::spawn</code></a>.</p>
<h1 id="errors-1" class="section-header"><a href="#errors-1">Errors</a></h1>
<p>Unlike the <a href="../../std/thread/fn.spawn.html"><code>spawn</code></a> free function, this method yields an
<a href="../../std/io/type.Result.html"><code>io::Result</code></a> to capture any failure to create the thread at
the OS level.</p>
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
<p>Panics if a thread name was set and it contained null bytes.</p>
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
<p>The caller has to ensure that no references in the supplied thread closure
or its return type can outlive the spawned thread's lifetime. This can be
guaranteed in two ways:</p>
<ul>
<li>ensure that [<code>join</code>][<code>JoinHandle::join</code>] is called before any referenced
data is dropped</li>
<li>use only types with <code>'static</code> lifetime bounds, i.e., those with no or only
<code>'static</code> references (both <a href="../../std/thread/struct.Builder.html#method.spawn"><code>thread::Builder::spawn</code></a>
and <a href="../../std/thread/fn.spawn.html"><code>thread::spawn</code></a> enforce this property statically)</li>
</ul>
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">thread_spawn_unchecked</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
<span class="kw">let</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">thread</span>::<span class="ident">Builder</span>::<span class="ident">new</span>();
<span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="number">1</span>;
<span class="kw">let</span> <span class="ident">thread_x</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">x</span>;
<span class="kw">let</span> <span class="ident">handler</span> <span class="op">=</span> <span class="kw">unsafe</span> {
<span class="ident">builder</span>.<span class="ident">spawn_unchecked</span>(<span class="kw">move</span> <span class="op">||</span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"x = {}"</span>, <span class="kw-2">*</span><span class="ident">thread_x</span>);
}).<span class="ident">unwrap</span>()
};
<span class="comment">// caller has to ensure `join()` is called, otherwise</span>
<span class="comment">// it is possible to access freed memory if `x` gets</span>
<span class="comment">// dropped before the thread closure is executed!</span>
<span class="ident">handler</span>.<span class="ident">join</span>().<span class="ident">unwrap</span>();</pre></div>
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Debug' class='impl'><code class='in-band'>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="../../../alacritty/util/thread/struct.Builder.html" title="struct alacritty::util::thread::Builder">Builder</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/thread/mod.rs.html#253' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/std/thread/mod.rs.html#253' title='goto source code'>[src]</a></h4><div class='docblock hidden'><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></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../../alacritty/util/thread/struct.Builder.html" title="struct alacritty::util::thread::Builder">Builder</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../../alacritty/util/thread/struct.Builder.html" title="struct alacritty::util::thread::Builder">Builder</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-From' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a> for T</code><a href='#impl-From' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#507-509' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#508' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Into' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#498-503' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#500-502' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryFrom' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#526-532' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#529-531' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Borrow' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#209-211' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div><h3 id='impl-BorrowMut' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-216' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#215' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id='impl-TryInto' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#514-521' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#518-520' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-SetParameter' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../gif/traits/trait.SetParameter.html" title="trait gif::traits::SetParameter">SetParameter</a> for T</code><a href='#impl-SetParameter' class='anchor'></a><a class='srclink' href='../../../src/gif/traits.rs.html#25' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.set' class="method"><code id='set.v'>fn <a href='../../../gif/traits/trait.SetParameter.html#method.set' class='fnname'>set</a><T>(&mut self, value: T) -> <T as <a class="trait" href="../../../gif/traits/trait.Parameter.html" title="trait gif::traits::Parameter">Parameter</a><Self>>::<a class="type" href="../../../gif/traits/trait.Parameter.html#associatedtype.Result" title="type gif::traits::Parameter::Result">Result</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../../gif/traits/trait.Parameter.html" title="trait gif::traits::Parameter">Parameter</a><Self>, </span></code><a class='srclink' href='../../../src/gif/traits.rs.html#20-22' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets <code>value</code> as a parameter of <code>self</code>.</p>
</div></div><h3 id='impl-Erased' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../owning_ref/trait.Erased.html" title="trait owning_ref::Erased">Erased</a> for T</code><a href='#impl-Erased' class='anchor'></a><a class='srclink' href='../../../src/owning_ref/lib.rs.html#281' title='goto source code'>[src]</a></h3><div class='impl-items'></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>⏎</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "alacritty";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
