47 lines
9.1 KiB
HTML
47 lines
9.1 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 `convert` mod in crate `nom`."><meta name="keywords" content="rust, rustlang, rust-lang, convert"><title>nom::lib::std::convert - 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 mod"><!--[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='../../../../nom/index.html'><div class='logo-container'><img src='../../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module convert</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../../index.html'>nom</a>::<wbr><a href='../../index.html'>lib</a>::<wbr><a href='../index.html'>std</a></p><script>window.sidebarCurrent = {name: 'convert', ty: 'mod', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled 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/core/lib.rs.html#212' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../../index.html'>nom</a>::<wbr><a href='../../index.html'>lib</a>::<wbr><a href='../index.html'>std</a>::<wbr><a class="mod" href=''>convert</a></span></h1><div class='docblock'><p>Traits for conversions between types.</p>
|
||
<p>The traits in this module provide a way to convert from one type to another type.
|
||
Each trait serves a different purpose:</p>
|
||
<ul>
|
||
<li>Implement the <a href="trait.AsRef.html"><code>AsRef</code></a> trait for cheap reference-to-reference conversions</li>
|
||
<li>Implement the <a href="trait.AsMut.html"><code>AsMut</code></a> trait for cheap mutable-to-mutable conversions</li>
|
||
<li>Implement the <a href="trait.From.html"><code>From</code></a> trait for consuming value-to-value conversions</li>
|
||
<li>Implement the <a href="trait.Into.html"><code>Into</code></a> trait for consuming value-to-value conversions to types
|
||
outside the current crate</li>
|
||
<li>The <a href="trait.TryFrom.html"><code>TryFrom</code></a> and <a href="trait.TryInto.html"><code>TryInto</code></a> traits behave like <a href="trait.From.html"><code>From</code></a> and <a href="trait.Into.html"><code>Into</code></a>,
|
||
but should be implemented when the conversion can fail.</li>
|
||
</ul>
|
||
<p>The traits in this module are often used as trait bounds for generic functions such that to
|
||
arguments of multiple types are supported. See the documentation of each trait for examples.</p>
|
||
<p>As a library author, you should always prefer implementing <a href="trait.From.html"><code>From<T></code></a> or
|
||
<a href="trait.TryFrom.html"><code>TryFrom<T></code></a> rather than <a href="trait.Into.html"><code>Into<U></code></a> or <a href="trait.TryInto.html"><code>TryInto<U></code></a>,
|
||
as <a href="trait.From.html"><code>From</code></a> and <a href="trait.TryFrom.html"><code>TryFrom</code></a> provide greater flexibility and offer
|
||
equivalent <a href="trait.Into.html"><code>Into</code></a> or <a href="trait.TryInto.html"><code>TryInto</code></a> implementations for free, thanks to a
|
||
blanket implementation in the standard library. Only implement <a href="trait.Into.html"><code>Into</code></a> or <a href="trait.TryInto.html"><code>TryInto</code></a>
|
||
when a conversion to a type outside the current crate is required.</p>
|
||
<h1 id="generic-implementations" class="section-header"><a href="#generic-implementations">Generic Implementations</a></h1>
|
||
<ul>
|
||
<li><a href="trait.AsRef.html"><code>AsRef</code></a> and <a href="trait.AsMut.html"><code>AsMut</code></a> auto-dereference if the inner type is a reference</li>
|
||
<li><a href="trait.From.html"><code>From</code></a><code><U> for T</code> implies <a href="trait.Into.html"><code>Into</code></a><code><T> for U</code></li>
|
||
<li><a href="trait.TryFrom.html"><code>TryFrom</code></a><code><U> for T</code> implies <a href="trait.TryInto.html"><code>TryInto</code></a><code><T> for U</code></li>
|
||
<li><a href="trait.From.html"><code>From</code></a> and <a href="trait.Into.html"><code>Into</code></a> are reflexive, which means that all types can
|
||
<code>into</code> themselves and <code>from</code> themselves</li>
|
||
</ul>
|
||
<p>See each trait for usage examples.</p>
|
||
</div><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table><tr class='module-item'><td><a class="enum" href="enum.Infallible.html" title='nom::lib::std::convert::Infallible enum'>Infallible</a></td><td class='docblock-short'><p>The error type for errors that can never happen.</p>
|
||
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table><tr class='module-item'><td><a class="trait" href="trait.AsMut.html" title='nom::lib::std::convert::AsMut trait'>AsMut</a></td><td class='docblock-short'><p>Used to do a cheap mutable-to-mutable reference conversion.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.AsRef.html" title='nom::lib::std::convert::AsRef trait'>AsRef</a></td><td class='docblock-short'><p>Used to do a cheap reference-to-reference conversion.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.From.html" title='nom::lib::std::convert::From trait'>From</a></td><td class='docblock-short'><p>Used to do value-to-value conversions while consuming the input value. It is the reciprocal of
|
||
<a href="trait.Into.html"><code>Into</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Into.html" title='nom::lib::std::convert::Into trait'>Into</a></td><td class='docblock-short'><p>A value-to-value conversion that consumes the input value. The
|
||
opposite of <a href="trait.From.html"><code>From</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.TryFrom.html" title='nom::lib::std::convert::TryFrom trait'>TryFrom</a></td><td class='docblock-short'><p>Simple and safe type conversions that may fail in a controlled
|
||
way under some circumstances. It is the reciprocal of <a href="trait.TryInto.html"><code>TryInto</code></a>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="trait" href="trait.TryInto.html" title='nom::lib::std::convert::TryInto trait'>TryInto</a></td><td class='docblock-short'><p>An attempted conversion that consumes <code>self</code>, which may or may not be
|
||
expensive.</p>
|
||
</td></tr><tr class='unstable module-item'><td><a class="trait" href="trait.FloatToInt.html" title='nom::lib::std::convert::FloatToInt trait'>FloatToInt</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>Supporting trait for inherent methods of <code>f32</code> and <code>f64</code> such as <code>round_unchecked_to</code>.
|
||
Typically doesn’t need to be used directly.</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.identity.html" title='nom::lib::std::convert::identity fn'>identity</a></td><td class='docblock-short'><p>The identity function.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../../../";window.currentCrate = "nom";</script><script src="../../../../aliases.js"></script><script src="../../../../main.js"></script><script defer src="../../../../search-index.js"></script></body></html> |