| <!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/quote-1.0.28/src/format.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>format.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="../../quote/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="../../quote/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> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| </pre><pre class="rust"><code><span class="doccomment">/// Formatting macro for constructing `Ident`s. |
| /// |
| /// <br> |
| /// |
| /// # Syntax |
| /// |
| /// Syntax is copied from the [`format!`] macro, supporting both positional and |
| /// named arguments. |
| /// |
| /// Only a limited set of formatting traits are supported. The current mapping |
| /// of format types to traits is: |
| /// |
| /// * `{}` ⇒ [`IdentFragment`] |
| /// * `{:o}` ⇒ [`Octal`](std::fmt::Octal) |
| /// * `{:x}` ⇒ [`LowerHex`](std::fmt::LowerHex) |
| /// * `{:X}` ⇒ [`UpperHex`](std::fmt::UpperHex) |
| /// * `{:b}` ⇒ [`Binary`](std::fmt::Binary) |
| /// |
| /// See [`std::fmt`] for more information. |
| /// |
| /// <br> |
| /// |
| /// # IdentFragment |
| /// |
| /// Unlike `format!`, this macro uses the [`IdentFragment`] formatting trait by |
| /// default. This trait is like `Display`, with a few differences: |
| /// |
| /// * `IdentFragment` is only implemented for a limited set of types, such as |
| /// unsigned integers and strings. |
| /// * [`Ident`] arguments will have their `r#` prefixes stripped, if present. |
| /// |
| /// [`IdentFragment`]: crate::IdentFragment |
| /// [`Ident`]: proc_macro2::Ident |
| /// |
| /// <br> |
| /// |
| /// # Hygiene |
| /// |
| /// The [`Span`] of the first `Ident` argument is used as the span of the final |
| /// identifier, falling back to [`Span::call_site`] when no identifiers are |
| /// provided. |
| /// |
| /// ``` |
| /// # use quote::format_ident; |
| /// # let ident = format_ident!("Ident"); |
| /// // If `ident` is an Ident, the span of `my_ident` will be inherited from it. |
| /// let my_ident = format_ident!("My{}{}", ident, "IsCool"); |
| /// assert_eq!(my_ident, "MyIdentIsCool"); |
| /// ``` |
| /// |
| /// Alternatively, the span can be overridden by passing the `span` named |
| /// argument. |
| /// |
| /// ``` |
| /// # use quote::format_ident; |
| /// # const IGNORE_TOKENS: &'static str = stringify! { |
| /// let my_span = /* ... */; |
| /// # }; |
| /// # let my_span = proc_macro2::Span::call_site(); |
| /// format_ident!("MyIdent", span = my_span); |
| /// ``` |
| /// |
| /// [`Span`]: proc_macro2::Span |
| /// [`Span::call_site`]: proc_macro2::Span::call_site |
| /// |
| /// <p><br></p> |
| /// |
| /// # Panics |
| /// |
| /// This method will panic if the resulting formatted string is not a valid |
| /// identifier. |
| /// |
| /// <br> |
| /// |
| /// # Examples |
| /// |
| /// Composing raw and non-raw identifiers: |
| /// ``` |
| /// # use quote::format_ident; |
| /// let my_ident = format_ident!("My{}", "Ident"); |
| /// assert_eq!(my_ident, "MyIdent"); |
| /// |
| /// let raw = format_ident!("r#Raw"); |
| /// assert_eq!(raw, "r#Raw"); |
| /// |
| /// let my_ident_raw = format_ident!("{}Is{}", my_ident, raw); |
| /// assert_eq!(my_ident_raw, "MyIdentIsRaw"); |
| /// ``` |
| /// |
| /// Integer formatting options: |
| /// ``` |
| /// # use quote::format_ident; |
| /// let num: u32 = 10; |
| /// |
| /// let decimal = format_ident!("Id_{}", num); |
| /// assert_eq!(decimal, "Id_10"); |
| /// |
| /// let octal = format_ident!("Id_{:o}", num); |
| /// assert_eq!(octal, "Id_12"); |
| /// |
| /// let binary = format_ident!("Id_{:b}", num); |
| /// assert_eq!(binary, "Id_1010"); |
| /// |
| /// let lower_hex = format_ident!("Id_{:x}", num); |
| /// assert_eq!(lower_hex, "Id_a"); |
| /// |
| /// let upper_hex = format_ident!("Id_{:X}", num); |
| /// assert_eq!(upper_hex, "Id_A"); |
| /// ``` |
| </span><span class="attribute">#[macro_export] |
| </span><span class="macro">macro_rules! </span>format_ident { |
| (<span class="macro-nonterminal">$fmt</span>:expr) => { |
| <span class="macro-nonterminal">$</span><span class="macro">crate::format_ident_impl!</span>([ |
| <span class="macro-nonterminal">$crate::__private::Option::None</span>, |
| <span class="macro-nonterminal">$fmt |
| </span>]) |
| }; |
| |
| (<span class="macro-nonterminal">$fmt</span>:expr, $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { |
| <span class="macro-nonterminal">$</span><span class="macro">crate::format_ident_impl!</span>([ |
| <span class="macro-nonterminal">$crate::__private::Option::None</span>, |
| <span class="macro-nonterminal">$fmt |
| </span>] $(<span class="macro-nonterminal">$rest</span>)<span class="kw-2">*</span>) |
| }; |
| } |
| |
| <span class="attribute">#[macro_export] |
| #[doc(hidden)] |
| </span><span class="macro">macro_rules! </span>format_ident_impl { |
| <span class="comment">// Final state |
| </span>([<span class="macro-nonterminal">$span</span>:expr, $(<span class="macro-nonterminal">$fmt</span>:tt)<span class="kw-2">*</span>]) => { |
| <span class="macro-nonterminal">$crate::__private::mk_ident</span>( |
| <span class="kw-2">&</span><span class="macro-nonterminal">$</span><span class="macro">crate::__private::format!</span>($(<span class="macro-nonterminal">$fmt</span>)<span class="kw-2">*</span>), |
| <span class="macro-nonterminal">$span</span>, |
| ) |
| }; |
| |
| <span class="comment">// Span argument |
| </span>([<span class="macro-nonterminal">$old</span>:expr, $(<span class="macro-nonterminal">$fmt</span>:tt)<span class="kw-2">*</span>] span = <span class="macro-nonterminal">$span</span>:expr) => { |
| <span class="macro-nonterminal">$</span><span class="macro">crate::format_ident_impl!</span>([<span class="macro-nonterminal">$old</span>, $(<span class="macro-nonterminal">$fmt</span>)<span class="kw-2">*</span>] span = <span class="macro-nonterminal">$span</span>,) |
| }; |
| ([<span class="macro-nonterminal">$old</span>:expr, $(<span class="macro-nonterminal">$fmt</span>:tt)<span class="kw-2">*</span>] span = <span class="macro-nonterminal">$span</span>:expr, $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { |
| <span class="macro-nonterminal">$</span><span class="macro">crate::format_ident_impl!</span>([ |
| <span class="macro-nonterminal">$crate::__private::Option::Some</span>::<<span class="macro-nonterminal">$crate::__private::Span</span>>(<span class="macro-nonterminal">$span</span>), |
| $(<span class="macro-nonterminal">$fmt</span>)* |
| ] $(<span class="macro-nonterminal">$rest</span>)<span class="kw-2">*</span>) |
| }; |
| |
| <span class="comment">// Named argument |
| </span>([<span class="macro-nonterminal">$span</span>:expr, $(<span class="macro-nonterminal">$fmt</span>:tt)<span class="kw-2">*</span>] <span class="macro-nonterminal">$name</span>:ident = <span class="macro-nonterminal">$arg</span>:expr) => { |
| <span class="macro-nonterminal">$</span><span class="macro">crate::format_ident_impl!</span>([<span class="macro-nonterminal">$span</span>, $(<span class="macro-nonterminal">$fmt</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$name </span>= <span class="macro-nonterminal">$arg</span>,) |
| }; |
| ([<span class="macro-nonterminal">$span</span>:expr, $(<span class="macro-nonterminal">$fmt</span>:tt)<span class="kw-2">*</span>] <span class="macro-nonterminal">$name</span>:ident = <span class="macro-nonterminal">$arg</span>:expr, $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { |
| <span class="kw">match </span><span class="macro-nonterminal">$crate::__private::IdentFragmentAdapter</span>(<span class="kw-2">&</span><span class="macro-nonterminal">$arg</span>) { |
| arg => <span class="macro-nonterminal">$</span><span class="macro">crate::format_ident_impl!</span>([<span class="macro-nonterminal">$span</span>.or(arg.span()), $(<span class="macro-nonterminal">$fmt</span>)<span class="kw-2">*</span>, <span class="macro-nonterminal">$name </span>= arg] $(<span class="macro-nonterminal">$rest</span>)<span class="kw-2">*</span>), |
| } |
| }; |
| |
| <span class="comment">// Positional argument |
| </span>([<span class="macro-nonterminal">$span</span>:expr, $(<span class="macro-nonterminal">$fmt</span>:tt)<span class="kw-2">*</span>] <span class="macro-nonterminal">$arg</span>:expr) => { |
| <span class="macro-nonterminal">$</span><span class="macro">crate::format_ident_impl!</span>([<span class="macro-nonterminal">$span</span>, $(<span class="macro-nonterminal">$fmt</span>)<span class="kw-2">*</span>] <span class="macro-nonterminal">$arg</span>,) |
| }; |
| ([<span class="macro-nonterminal">$span</span>:expr, $(<span class="macro-nonterminal">$fmt</span>:tt)<span class="kw-2">*</span>] <span class="macro-nonterminal">$arg</span>:expr, $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { |
| <span class="kw">match </span><span class="macro-nonterminal">$crate::__private::IdentFragmentAdapter</span>(<span class="kw-2">&</span><span class="macro-nonterminal">$arg</span>) { |
| arg => <span class="macro-nonterminal">$</span><span class="macro">crate::format_ident_impl!</span>([<span class="macro-nonterminal">$span</span>.or(arg.span()), $(<span class="macro-nonterminal">$fmt</span>)<span class="kw-2">*</span>, arg] $(<span class="macro-nonterminal">$rest</span>)<span class="kw-2">*</span>), |
| } |
| }; |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="quote" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |