blob: 8feb6bd0d95cef1b4e33353cbdc7d0f0c58e1527 [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/syn-2.0.18/src/lifetime.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lifetime.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../syn/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../syn/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
</pre><pre class="rust"><code><span class="kw">use </span>proc_macro2::{Ident, Span};
<span class="kw">use </span>std::cmp::Ordering;
<span class="kw">use </span>std::fmt::{<span class="self">self</span>, Display};
<span class="kw">use </span>std::hash::{Hash, Hasher};
<span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">use </span><span class="kw">crate</span>::lookahead;
<span class="doccomment">/// A Rust lifetime: `&#39;a`.
///
/// Lifetime names must conform to the following rules:
///
/// - Must start with an apostrophe.
/// - Must not consist of just an apostrophe: `&#39;`.
/// - Character after the apostrophe must be `_` or a Unicode code point with
/// the XID_Start property.
/// - All following characters must be Unicode code points with the XID_Continue
/// property.
</span><span class="kw">pub struct </span>Lifetime {
<span class="kw">pub </span>apostrophe: Span,
<span class="kw">pub </span>ident: Ident,
}
<span class="kw">impl </span>Lifetime {
<span class="doccomment">/// # Panics
///
/// Panics if the lifetime does not conform to the bulleted rules above.
///
/// # Invocation
///
/// ```
/// # use proc_macro2::Span;
/// # use syn::Lifetime;
/// #
/// # fn f() -&gt; Lifetime {
/// Lifetime::new(&quot;&#39;a&quot;, Span::call_site())
/// # }
/// ```
</span><span class="kw">pub fn </span>new(symbol: <span class="kw-2">&amp;</span>str, span: Span) -&gt; <span class="self">Self </span>{
<span class="kw">if </span>!symbol.starts_with(<span class="string">&#39;\&#39;&#39;</span>) {
<span class="macro">panic!</span>(
<span class="string">&quot;lifetime name must start with apostrophe as in \&quot;&#39;a\&quot;, got {:?}&quot;</span>,
symbol
);
}
<span class="kw">if </span>symbol == <span class="string">&quot;&#39;&quot; </span>{
<span class="macro">panic!</span>(<span class="string">&quot;lifetime name must not be empty&quot;</span>);
}
<span class="kw">if </span>!<span class="kw">crate</span>::ident::xid_ok(<span class="kw-2">&amp;</span>symbol[<span class="number">1</span>..]) {
<span class="macro">panic!</span>(<span class="string">&quot;{:?} is not a valid lifetime name&quot;</span>, symbol);
}
Lifetime {
apostrophe: span,
ident: Ident::new(<span class="kw-2">&amp;</span>symbol[<span class="number">1</span>..], span),
}
}
<span class="kw">pub fn </span>span(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Span {
<span class="self">self</span>.apostrophe
.join(<span class="self">self</span>.ident.span())
.unwrap_or(<span class="self">self</span>.apostrophe)
}
<span class="kw">pub fn </span>set_span(<span class="kw-2">&amp;mut </span><span class="self">self</span>, span: Span) {
<span class="self">self</span>.apostrophe = span;
<span class="self">self</span>.ident.set_span(span);
}
}
<span class="kw">impl </span>Display <span class="kw">for </span>Lifetime {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, formatter: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="string">&quot;&#39;&quot;</span>.fmt(formatter)<span class="question-mark">?</span>;
<span class="self">self</span>.ident.fmt(formatter)
}
}
<span class="kw">impl </span>Clone <span class="kw">for </span>Lifetime {
<span class="kw">fn </span>clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
Lifetime {
apostrophe: <span class="self">self</span>.apostrophe,
ident: <span class="self">self</span>.ident.clone(),
}
}
}
<span class="kw">impl </span>PartialEq <span class="kw">for </span>Lifetime {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>Lifetime) -&gt; bool {
<span class="self">self</span>.ident.eq(<span class="kw-2">&amp;</span>other.ident)
}
}
<span class="kw">impl </span>Eq <span class="kw">for </span>Lifetime {}
<span class="kw">impl </span>PartialOrd <span class="kw">for </span>Lifetime {
<span class="kw">fn </span>partial_cmp(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>Lifetime) -&gt; <span class="prelude-ty">Option</span>&lt;Ordering&gt; {
<span class="prelude-val">Some</span>(<span class="self">self</span>.cmp(other))
}
}
<span class="kw">impl </span>Ord <span class="kw">for </span>Lifetime {
<span class="kw">fn </span>cmp(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span>Lifetime) -&gt; Ordering {
<span class="self">self</span>.ident.cmp(<span class="kw-2">&amp;</span>other.ident)
}
}
<span class="kw">impl </span>Hash <span class="kw">for </span>Lifetime {
<span class="kw">fn </span>hash&lt;H: Hasher&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, h: <span class="kw-2">&amp;mut </span>H) {
<span class="self">self</span>.ident.hash(h);
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
#[doc(hidden)]
#[allow(non_snake_case)]
</span><span class="kw">pub fn </span>Lifetime(marker: lookahead::TokenMarker) -&gt; Lifetime {
<span class="kw">match </span>marker {}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>parsing {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::parse::{Parse, ParseStream, <span class="prelude-ty">Result</span>};
<span class="attribute">#[cfg_attr(doc_cfg, doc(cfg(feature = <span class="string">&quot;parsing&quot;</span>)))]
</span><span class="kw">impl </span>Parse <span class="kw">for </span>Lifetime {
<span class="kw">fn </span>parse(input: ParseStream) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>&gt; {
input.step(|cursor| {
cursor
.lifetime()
.ok_or_else(|| cursor.error(<span class="string">&quot;expected lifetime&quot;</span>))
})
}
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;printing&quot;</span>)]
</span><span class="kw">mod </span>printing {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span>proc_macro2::{Punct, Spacing, TokenStream};
<span class="kw">use </span>quote::{ToTokens, TokenStreamExt};
<span class="attribute">#[cfg_attr(doc_cfg, doc(cfg(feature = <span class="string">&quot;printing&quot;</span>)))]
</span><span class="kw">impl </span>ToTokens <span class="kw">for </span>Lifetime {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
<span class="kw">let </span><span class="kw-2">mut </span>apostrophe = Punct::new(<span class="string">&#39;\&#39;&#39;</span>, Spacing::Joint);
apostrophe.set_span(<span class="self">self</span>.apostrophe);
tokens.append(apostrophe);
<span class="self">self</span>.ident.to_tokens(tokens);
}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="syn" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>