<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `WeightedIndex` struct in crate `rand`."><metaname="keywords"content="rust, rustlang, rust-lang, WeightedIndex"><title>rand::distributions::weighted::WeightedIndex - Rust</title><linkrel="stylesheet"type="text/css"href="../../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../../dark.css"><linkrel="stylesheet"type="text/css"href="../../../light.css"id="themeStyle"><scriptsrc="../../../storage.js"></script><noscript><linkrel="stylesheet"href="../../../noscript.css"></noscript><linkrel="shortcut icon"href="https://www.rust-lang.org/favicon.ico"><styletype="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../../../rand/index.html'><divclass='logo-container'><imgsrc='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png'alt='logo'></div></a><pclass='location'>Struct WeightedIndex</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.new">new</a></div><aclass="sidebar-title"href="#implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Clone">Clone</a><ahref="#impl-Debug">Debug</a><ahref="#impl-Distribution%3Cusize%3E">Distribution<usize></a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-ToOwned">ToOwned</a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a><ahref="#impl-VZip%3CV%3E">VZip<V></a></div></div><pclass='location'><ahref='../../index.html'>rand</a>::<wbr><ahref='../index.html'>distributions</a>::<wbr><ahref='index.html'>weighted</a></p><script>window.sidebarCurrent={name:'WeightedIndex',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../../../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../../../theme.js"></script><navclass="sub"><formclass="search-form js-only"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><aid="settings-menu"href="../../../settings.html"><imgsrc="../../../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class='fqn'><spanclass='out-of-band'><spanid='render-detail'><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass='inner'>−</span>]</a></span><aclass='srclink'href='../../../src/rand/distributions/weighted/mod.rs.html#85-88'title='goto source code'>[src]</a></span><spanclass='in-band'>Struct <ahref='../../index.html'>rand</a>::<wbr><ahre
item.</p>
<p>Sampling a <code>WeightedIndex</code> distribution returns the index of a randomly
selected element from the iterator used when the <code>WeightedIndex</code> was
created. The chance of a given element being picked is proportional to the
value of the element. The weights can use any type <code>X</code> for which an
implementation of <ahref="../../../rand/distributions/uniform/struct.Uniform.html"><code>Uniform<X></code></a> exists.</p>
<p>A <code>WeightedIndex<X></code> contains a <code>Vec<X></code> and a <ahref="../../../rand/distributions/uniform/struct.Uniform.html"><code>Uniform<X></code></a> and so its
size is the sum of the size of those objects, possibly plus some alignment.</p>
<p>Creating a <code>WeightedIndex<X></code> will allocate enough space to hold <code>N - 1</code>
weights of type <code>X</code>, where <code>N</code> is the number of weights. However, since
<code>Vec</code> doesn't guarantee a particular growth strategy, additional memory
might be allocated but not used. Since the <code>WeightedIndex</code> object also
contains, this might cause additional allocations, though for primitive
types, ['Uniform<X>`] doesn't allocate any memory.</p>
<p>Time complexity of sampling from <code>WeightedIndex</code> is <code>O(log N)</code> where
<code>N</code> is the number of weights.</p>
<p>Sampling from <code>WeightedIndex</code> will result in a single call to
<code>Uniform<X>::sample</code> (method of the <ahref="../../../rand/distributions/trait.Distribution.html"title="`Distribution`"><code>Distribution</code></a> trait), which typically
will request a single value from the underlying <ahref="../../../rand/trait.RngCore.html"><code>RngCore</code></a>, though the
exact number depends on the implementaiton of <code>Uniform<X>::sample</code>.</p>
</div><h2id='methods'class='small-section-header'>Methods<ahref='#methods'class='anchor'></a></h2><h3id='impl'class='impl'><codeclass='in-band'>impl<X: <aclass="trait"href="../../../rand/distributions/uniform/trait.SampleUniform.html"title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html"title="trait core::cmp::PartialOrd">PartialOrd</a>><aclass="struct"href="../../../rand/distributions/weighted/struct.WeightedIndex.html"title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X></code><ahref='#impl'class='anchor'></a><aclass='srclink'href='../../../src/rand/distributions/weighted/mod.rs.html#90-132'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.new'class="method"><codeid='new.v'>pub fn <ahref='#method.new'class='fnname'>new</a><I>(weights: I) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="../../../rand/distributions/weighted/struct.WeightedIndex.html"title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X>, <aclass="enum"href="../../../rand/distributions/weighted/enum.WeightedError.html"title="enum rand::distributions::weighted::WeightedError">WeightedError</a>><spanclass="where fmt-newline">where<br> I: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html"title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> I::<aclass="type"href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item"title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <aclass="trait"href="../../../rand/distributions/uniform/trait.SampleBorrow.html"title="trait rand::distributions::uniform::SampleBorrow">SampleBorrow</a><X>,<br> X: for<'a><aclass="trait"href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.AddAssign.html"title="trait core::ops::arith::AddAssign">AddAssign</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>X> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html"title="trait core::default::Default">Default</a>, </span></code><aclass='srclink'href='../../../src/rand/distributions/weighted/mod.rs.html#99-131'title='goto source code'>[src]</a></h4><divclass='docblock'><p>Creates a new a <code>WeightedIndex</code><ahref="../../../rand/distributions/trait.Distribution.html"title="`Distribution`"><code>Distribution</code></a> using the values
in <code>weights</code>. The weights can use any type <code>X</code> for which an
implementation of <ahref="../../../rand/distributions/uniform/struct.Uniform.html"><code>Uniform<X></code></a> exists.</p>
<p>Returns an error if the iterator is empty, if any weight is <code>< 0</code>, or
if its total value is 0.</p>
</div></div><h2id='implementations'class='small-section-header'>Trait Implementations<ahref='#implementations'class='anchor'></a></h2><divid='implementations-list'><h3id='impl-Distribution%3Cusize%3E'class='impl'><codeclass='in-band'>impl<X><aclass="trait"href="../../../rand/distributions/trait.Distribution.html"title="trait rand::distributions::Distribution">Distribution</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> for <aclass="struct"href="../../../rand/distributions/weighted/struct.WeightedIndex.html"title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><spanclass="where fmt-newline">where<br> X: <aclass="trait"href="../../../rand/distributions/uniform/trait.SampleUniform.html"title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html"title="trait core::cmp::PartialOrd">PartialOrd</a>, </span></code><ahref='#impl-Distribution%3Cusize%3E'class='anchor'></a><aclass='srclink'href='../../../src/rand/distributions/weighted/mod.rs.html#134-143'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.sample'class="method hidden"><codeid='sample.v'>fn <ahref='../../../rand/distributions/trait.Distribution.html#tymethod.sample'class='fnname'>sample</a><R: <aclass="trait"href="../../../rand/trait.Rng.html"title="trait rand::Rng">Rng</a> + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>>(&self, rng: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>R) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><aclass='srclink'href='../../../src/rand/distributions/weighted/mod.rs.html#136-142'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Generate a random value of <code>T</code>, using <code>rng</code> as the source of randomness.</p>
</div><h4id='method.sample_iter'class="method hidden"><divclass="important-traits"><divclass='tooltip'>ⓘ<spanclass='tooltiptext'>Important traits for <aclass="struct"href="../../../rand/distributions/struct.DistIter.html"title="struct rand::distributions::DistIter">DistIter</a><D, R, T></span></div><divclass="content hidden"><h3class="important">Important traits for <aclass="struct"href="../../../rand/distributions/struct.DistIter.html"title="struct rand::distributions::DistIter">DistIter</a><D, R, T></h3><codeclass="content"><spanclass="where fmt-newline">impl<D, R, T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html"title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <aclass="struct"href="../../../rand/distributions/struct.DistIter.html"title="struct rand::distributions::DistIter">DistIter</a><D, R, T><spanclass="where fmt-newline">where<br> D: <aclass="trait"href="../../../rand/distributions/trait.Distribution.html"title="trait rand::distributions::Distribution">Distribution</a><T>,<br> R: <aclass="trait"href="../../../rand/trait.Rng.html"title="trait rand::Rng">Rng</a>, </span></span><spanclass="where fmt-newline"> type <ahref='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item'class="type">Item</a> = T;</span></code></div></div><codeid='sample_iter.v'>fn <ahref='../../../rand/distributions/trait.Distribution.html#method.sample_iter'class='fnname'>sample_iter</a><R>(self, rng: R) -><aclass="struct"href="../../../rand/distributions/struct.DistIter.html"title="struct rand::distributions::DistIter">DistIter</a><Self, R, T><spanclass="where fmt-newline">where<br> R: <aclass="trait"href="../../../rand/trait.Rng.html"title="trait rand::Rng">Rng</a>,<br> Self: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><aclass='srclink'href='../../../src/rand/distributions/mod.rs.html#211-219'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Create an iterator that generates random values of <code>T</code>, using <code>rng</code> as the source of randomness. <ahref="../../../rand/distributions/trait.Distribution.html#method.sample_iter">Read more</a></p>
</div></div><h3id='impl-Clone'class='impl'><codeclass='in-band'>impl<X: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="../../../rand/distributions/uniform/trait.SampleUniform.html"title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html"title="trait core::cmp::PartialOrd">PartialOrd</a>><aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> for <aclass="struct"href="../../../rand/distributions/weighted/struct.WeightedIndex.html"title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><spanclass="where fmt-newline">where<br> X::<aclass="type"href="../../../rand/distributions/uniform/trait.SampleUniform.html#associatedtype.Sampler"title="type rand::distributions::uniform::SampleUniform::Sampler">Sampler</a>: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>, </span></code><ahref='#impl-Clone'class='anchor'></a><aclass='srclink'href='../../../src/rand/distributions/weighted/mod.rs.html#84'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.clone'class="method hidden"><codeid='clone.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone'class='fnname'>clone</a>(&self) -><aclass="struct"href="../../../rand/distributions/weighted/struct.WeightedIndex.html"title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X></code><aclass='srclink'href='../../../src/rand/distributions/weighted/mod.rs.html#84'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Returns a copy of the value. <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4id='method.clone_from'class="method hidden"><codeid='clone_from.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from'class='fnname'>clone_from</a>(&mut self, source: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><spanclass='since'title='Stable since Rust version 1.0.0'>1.0.0</span><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <ahref="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3id='impl-Debug'class='impl'><codeclass='in-band'>impl<X: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> + <aclass="trait"href="../../../rand/distributions/uniform/trait.SampleUniform.html"title="trait rand::distributions::uniform::SampleUniform">SampleUniform</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html"title="trait core::cmp::PartialOrd">PartialOrd</a>><aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> for <aclass="struct"href="../../../rand/distributions/weighted/struct.WeightedIndex.html"title="struct rand::distributions::weighted::WeightedIndex">WeightedIndex</a><X><spanclass="where fmt-newline">where<br> X::<aclass="type"href="../../../rand/distributions/uniform/trait.SampleUniform.html#associatedtype.Sampler"title="type rand::distributions::uniform::SampleUniform::Sampler">Sampler</a>: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a>, </span></code><ahref='#impl-Debug'class='anchor'></a><aclass='srclink'href='../../../src/rand/distributions/weighted/mod.rs.html#84'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.fmt'class="method hidden"><codeid='fmt.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt'class='fnname'>fmt</a>(&self, f: &mut <aclass="struct"href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html"title="struct core::fmt::Formatter">Formatter</a>) -><aclass="type"href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html"title="type core::fmt::Result">Result</a></code><aclass='srclink'href='../../../src/rand/distributions/weighted/mod.rs.html#84'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Formats the value using the given formatter. <ahref="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3id='impl-ToOwned'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T <spanclass="where fmt-newline">where<br> T: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>, </span></code><ahref='#impl-ToOwned'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Owned'class="type"><codeid='Owned.t'>type <ahref='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned'class="type">Owned</a> = T</code></h4><divclass='docblock'><p>The resulting type after obtaining ownership.</p>
</div><h4id='method.to_owned'class="method hidden"><codeid='to_owned.v'>fn <ahref='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned'class='fnname'>to_owned</a>(&self) -> T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div><h4id='method.clone_into'class="method hidden"><codeid='clone_into.v'>fn <ahref='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into'class='fnname'>clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91'title='goto source code'>[src]</a></h4><divclass='stability hidden'><divclass='stab unstable'><details><summary><spanclass='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
</details></div></div><divclass='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></div><h3id='impl-TryFrom%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></code><ahref='#impl-TryFrom%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#571-577'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error'class="type"><codeid='Error.t'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error'class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_from'class="method hidden"><codeid='try_from.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from'class='fnname'>try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#574-576'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-TryInto%3CU%3E'class='impl'><codeclass='in-band'>impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><ahref='#impl-TryInto%3CU%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#559-566'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='associatedtype.Error-1'class="type"><codeid='Error.t-1'>type <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error'class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="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><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id='method.try_into'class="method hidden"><codeid='try_into.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into'class='fnname'>try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#563-565'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id='impl-BorrowMut%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-BorrowMut%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow_mut'class="method hidden"><codeid='borrow_mut.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut'class='fnname'>borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3id='impl-Borrow%3CT%3E'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a><T> for T <spanclass="where fmt-newline">where<br> T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Borrow%3CT%3E'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.borrow'class="method hidden"><codeid='borrow.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow'class='fnname'>borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3id='impl-Any'class='impl'><codeclass='in-band'>impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html"title="trait core::any::Any">Any</a> for T <spanclass="where fmt-newline">where<br> T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>, </span></code><ahref='#impl-Any'class='anchor'></a><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.type_id'class="method hidden"><codeid='type_id.v'>fn <ahref='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id'class='fnname'>type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></code><aclass='srclink'href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101'title='goto source code'>[src]</a></h4><divclass='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div><h3id='impl-VZip%3CV%3E'class='impl'><codeclass='in-band'>impl<V, T><aclass="trait"href="../../../ppv_lite86/types/types/trait.VZip.html"title="trait ppv_lite86::types::types::VZip">VZip</a><V> for T <spanclass="where fmt-newline">where<br> V: <aclass="trait"href="../../../ppv_lite86/types/types/trait.MultiLane.html"title="trait ppv_lite86::types::types::MultiLane">MultiLane</a><T>, </span></code><ahref='#impl-VZip%3CV%3E'class='anchor'></a><aclass='srclink'href='../../../src/ppv_lite86/types.rs.html#212-220'title='goto source code'>[src]</a></h3><divclass='impl-items'><h4id='method.vzip'class="method hidden"><codeid='vzip.v'>fn <ahref='../../../ppv_lite86/types/types/trait.VZip.html#tymethod.vzip'class='fnname'>vzip</a>(self) -> V</code><aclass='srclink'href='../../../src/ppv_lite86/types.rs.html#217-219'title='goto source code'>[src]</a></h4></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="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><divclass="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="rand";</script><scriptsrc="../../../aliases.js"></script><scriptsrc="../../../main.js"></script><scriptdefersrc="../../../search-index.js"></script></body></html>
