394 lines
No EOL
43 KiB
HTML
394 lines
No EOL
43 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 `Literal` struct in crate `proc_macro2`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Literal">
|
||
|
||
<title>proc_macro2::Literal - 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="../main.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</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>
|
||
|
||
<p class='location'>Struct Literal</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.u8_suffixed">u8_suffixed</a><a href="#method.u16_suffixed">u16_suffixed</a><a href="#method.u32_suffixed">u32_suffixed</a><a href="#method.u64_suffixed">u64_suffixed</a><a href="#method.usize_suffixed">usize_suffixed</a><a href="#method.i8_suffixed">i8_suffixed</a><a href="#method.i16_suffixed">i16_suffixed</a><a href="#method.i32_suffixed">i32_suffixed</a><a href="#method.i64_suffixed">i64_suffixed</a><a href="#method.isize_suffixed">isize_suffixed</a><a href="#method.u8_unsuffixed">u8_unsuffixed</a><a href="#method.u16_unsuffixed">u16_unsuffixed</a><a href="#method.u32_unsuffixed">u32_unsuffixed</a><a href="#method.u64_unsuffixed">u64_unsuffixed</a><a href="#method.usize_unsuffixed">usize_unsuffixed</a><a href="#method.i8_unsuffixed">i8_unsuffixed</a><a href="#method.i16_unsuffixed">i16_unsuffixed</a><a href="#method.i32_unsuffixed">i32_unsuffixed</a><a href="#method.i64_unsuffixed">i64_unsuffixed</a><a href="#method.isize_unsuffixed">isize_unsuffixed</a><a href="#method.f64_unsuffixed">f64_unsuffixed</a><a href="#method.f64_suffixed">f64_suffixed</a><a href="#method.f32_unsuffixed">f32_unsuffixed</a><a href="#method.f32_suffixed">f32_suffixed</a><a href="#method.string">string</a><a href="#method.character">character</a><a href="#method.byte_string">byte_string</a><a href="#method.span">span</a><a href="#method.set_span">set_span</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-From%3CLiteral%3E">From<Literal></a><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Display">Display</a></div></div><p class='location'><a href='index.html'>proc_macro2</a></p><script>window.sidebarCurrent = {name: 'Literal', 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">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>proc_macro2</a>::<wbr><a class="struct" href=''>Literal</a></span><span class='out-of-band'><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='../src/proc_macro2/lib.rs.html#878-881' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Literal { /* fields omitted */ }</pre><div class='docblock'><p>A literal string (<code>"hello"</code>), byte string (<code>b"hello"</code>), character (<code>'a'</code>),
|
||
byte character (<code>b'a'</code>), an integer or floating point number with or without
|
||
a suffix (<code>1</code>, <code>1u8</code>, <code>2.3</code>, <code>2.3f32</code>).</p>
|
||
<p>Boolean literals like <code>true</code> and <code>false</code> do not belong here, they are
|
||
<code>Ident</code>s.</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#923-1016' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.u8_suffixed' class="method"><span id='u8_suffixed.v' class='invisible'><code>pub fn <a href='#method.u8_suffixed' class='fnname'>u8_suffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#896-898' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new suffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1u32</code> where the integer
|
||
value specified is the first part of the token and the integral is
|
||
also suffixed at the end. Literals created from negative numbers may
|
||
not survive rountrips through <code>TokenStream</code> or strings and may be
|
||
broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.u16_suffixed' class="method"><span id='u16_suffixed.v' class='invisible'><code>pub fn <a href='#method.u16_suffixed' class='fnname'>u16_suffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#896-898' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new suffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1u32</code> where the integer
|
||
value specified is the first part of the token and the integral is
|
||
also suffixed at the end. Literals created from negative numbers may
|
||
not survive rountrips through <code>TokenStream</code> or strings and may be
|
||
broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.u32_suffixed' class="method"><span id='u32_suffixed.v' class='invisible'><code>pub fn <a href='#method.u32_suffixed' class='fnname'>u32_suffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#896-898' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new suffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1u32</code> where the integer
|
||
value specified is the first part of the token and the integral is
|
||
also suffixed at the end. Literals created from negative numbers may
|
||
not survive rountrips through <code>TokenStream</code> or strings and may be
|
||
broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.u64_suffixed' class="method"><span id='u64_suffixed.v' class='invisible'><code>pub fn <a href='#method.u64_suffixed' class='fnname'>u64_suffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#896-898' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new suffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1u32</code> where the integer
|
||
value specified is the first part of the token and the integral is
|
||
also suffixed at the end. Literals created from negative numbers may
|
||
not survive rountrips through <code>TokenStream</code> or strings and may be
|
||
broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.usize_suffixed' class="method"><span id='usize_suffixed.v' class='invisible'><code>pub fn <a href='#method.usize_suffixed' class='fnname'>usize_suffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#896-898' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new suffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1u32</code> where the integer
|
||
value specified is the first part of the token and the integral is
|
||
also suffixed at the end. Literals created from negative numbers may
|
||
not survive rountrips through <code>TokenStream</code> or strings and may be
|
||
broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.i8_suffixed' class="method"><span id='i8_suffixed.v' class='invisible'><code>pub fn <a href='#method.i8_suffixed' class='fnname'>i8_suffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#896-898' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new suffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1u32</code> where the integer
|
||
value specified is the first part of the token and the integral is
|
||
also suffixed at the end. Literals created from negative numbers may
|
||
not survive rountrips through <code>TokenStream</code> or strings and may be
|
||
broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.i16_suffixed' class="method"><span id='i16_suffixed.v' class='invisible'><code>pub fn <a href='#method.i16_suffixed' class='fnname'>i16_suffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#896-898' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new suffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1u32</code> where the integer
|
||
value specified is the first part of the token and the integral is
|
||
also suffixed at the end. Literals created from negative numbers may
|
||
not survive rountrips through <code>TokenStream</code> or strings and may be
|
||
broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.i32_suffixed' class="method"><span id='i32_suffixed.v' class='invisible'><code>pub fn <a href='#method.i32_suffixed' class='fnname'>i32_suffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#896-898' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new suffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1u32</code> where the integer
|
||
value specified is the first part of the token and the integral is
|
||
also suffixed at the end. Literals created from negative numbers may
|
||
not survive rountrips through <code>TokenStream</code> or strings and may be
|
||
broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.i64_suffixed' class="method"><span id='i64_suffixed.v' class='invisible'><code>pub fn <a href='#method.i64_suffixed' class='fnname'>i64_suffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#896-898' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new suffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1u32</code> where the integer
|
||
value specified is the first part of the token and the integral is
|
||
also suffixed at the end. Literals created from negative numbers may
|
||
not survive rountrips through <code>TokenStream</code> or strings and may be
|
||
broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.isize_suffixed' class="method"><span id='isize_suffixed.v' class='invisible'><code>pub fn <a href='#method.isize_suffixed' class='fnname'>isize_suffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#896-898' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new suffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1u32</code> where the integer
|
||
value specified is the first part of the token and the integral is
|
||
also suffixed at the end. Literals created from negative numbers may
|
||
not survive rountrips through <code>TokenStream</code> or strings and may be
|
||
broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.u8_unsuffixed' class="method"><span id='u8_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.u8_unsuffixed' class='fnname'>u8_unsuffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#917-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1</code> where the integer
|
||
value specified is the first part of the token. No suffix is
|
||
specified on this token, meaning that invocations like
|
||
<code>Literal::i8_unsuffixed(1)</code> are equivalent to
|
||
<code>Literal::u32_unsuffixed(1)</code>. Literals created from negative numbers
|
||
may not survive rountrips through <code>TokenStream</code> or strings and may
|
||
be broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.u16_unsuffixed' class="method"><span id='u16_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.u16_unsuffixed' class='fnname'>u16_unsuffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#917-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1</code> where the integer
|
||
value specified is the first part of the token. No suffix is
|
||
specified on this token, meaning that invocations like
|
||
<code>Literal::i8_unsuffixed(1)</code> are equivalent to
|
||
<code>Literal::u32_unsuffixed(1)</code>. Literals created from negative numbers
|
||
may not survive rountrips through <code>TokenStream</code> or strings and may
|
||
be broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.u32_unsuffixed' class="method"><span id='u32_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.u32_unsuffixed' class='fnname'>u32_unsuffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#917-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1</code> where the integer
|
||
value specified is the first part of the token. No suffix is
|
||
specified on this token, meaning that invocations like
|
||
<code>Literal::i8_unsuffixed(1)</code> are equivalent to
|
||
<code>Literal::u32_unsuffixed(1)</code>. Literals created from negative numbers
|
||
may not survive rountrips through <code>TokenStream</code> or strings and may
|
||
be broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.u64_unsuffixed' class="method"><span id='u64_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.u64_unsuffixed' class='fnname'>u64_unsuffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#917-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1</code> where the integer
|
||
value specified is the first part of the token. No suffix is
|
||
specified on this token, meaning that invocations like
|
||
<code>Literal::i8_unsuffixed(1)</code> are equivalent to
|
||
<code>Literal::u32_unsuffixed(1)</code>. Literals created from negative numbers
|
||
may not survive rountrips through <code>TokenStream</code> or strings and may
|
||
be broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.usize_unsuffixed' class="method"><span id='usize_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.usize_unsuffixed' class='fnname'>usize_unsuffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#917-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1</code> where the integer
|
||
value specified is the first part of the token. No suffix is
|
||
specified on this token, meaning that invocations like
|
||
<code>Literal::i8_unsuffixed(1)</code> are equivalent to
|
||
<code>Literal::u32_unsuffixed(1)</code>. Literals created from negative numbers
|
||
may not survive rountrips through <code>TokenStream</code> or strings and may
|
||
be broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.i8_unsuffixed' class="method"><span id='i8_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.i8_unsuffixed' class='fnname'>i8_unsuffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#917-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1</code> where the integer
|
||
value specified is the first part of the token. No suffix is
|
||
specified on this token, meaning that invocations like
|
||
<code>Literal::i8_unsuffixed(1)</code> are equivalent to
|
||
<code>Literal::u32_unsuffixed(1)</code>. Literals created from negative numbers
|
||
may not survive rountrips through <code>TokenStream</code> or strings and may
|
||
be broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.i16_unsuffixed' class="method"><span id='i16_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.i16_unsuffixed' class='fnname'>i16_unsuffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#917-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1</code> where the integer
|
||
value specified is the first part of the token. No suffix is
|
||
specified on this token, meaning that invocations like
|
||
<code>Literal::i8_unsuffixed(1)</code> are equivalent to
|
||
<code>Literal::u32_unsuffixed(1)</code>. Literals created from negative numbers
|
||
may not survive rountrips through <code>TokenStream</code> or strings and may
|
||
be broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.i32_unsuffixed' class="method"><span id='i32_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.i32_unsuffixed' class='fnname'>i32_unsuffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#917-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1</code> where the integer
|
||
value specified is the first part of the token. No suffix is
|
||
specified on this token, meaning that invocations like
|
||
<code>Literal::i8_unsuffixed(1)</code> are equivalent to
|
||
<code>Literal::u32_unsuffixed(1)</code>. Literals created from negative numbers
|
||
may not survive rountrips through <code>TokenStream</code> or strings and may
|
||
be broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.i64_unsuffixed' class="method"><span id='i64_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.i64_unsuffixed' class='fnname'>i64_unsuffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#917-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1</code> where the integer
|
||
value specified is the first part of the token. No suffix is
|
||
specified on this token, meaning that invocations like
|
||
<code>Literal::i8_unsuffixed(1)</code> are equivalent to
|
||
<code>Literal::u32_unsuffixed(1)</code>. Literals created from negative numbers
|
||
may not survive rountrips through <code>TokenStream</code> or strings and may
|
||
be broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.isize_unsuffixed' class="method"><span id='isize_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.isize_unsuffixed' class='fnname'>isize_unsuffixed</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#917-919' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed integer literal with the specified value.</p>
|
||
<p>This function will create an integer like <code>1</code> where the integer
|
||
value specified is the first part of the token. No suffix is
|
||
specified on this token, meaning that invocations like
|
||
<code>Literal::i8_unsuffixed(1)</code> are equivalent to
|
||
<code>Literal::u32_unsuffixed(1)</code>. Literals created from negative numbers
|
||
may not survive rountrips through <code>TokenStream</code> or strings and may
|
||
be broken into two tokens (<code>-</code> and positive literal).</p>
|
||
<p>Literals created through this method have the <code>Span::call_site()</code>
|
||
span by default, which can be configured with the <code>set_span</code> method
|
||
below.</p>
|
||
</div><h4 id='method.f64_unsuffixed' class="method"><span id='f64_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.f64_unsuffixed' class='fnname'>f64_unsuffixed</a>(f: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#964-967' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.f64_suffixed' class="method"><span id='f64_suffixed.v' class='invisible'><code>pub fn <a href='#method.f64_suffixed' class='fnname'>f64_suffixed</a>(f: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#969-972' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.f32_unsuffixed' class="method"><span id='f32_unsuffixed.v' class='invisible'><code>pub fn <a href='#method.f32_unsuffixed' class='fnname'>f32_unsuffixed</a>(f: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#987-990' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new unsuffixed floating-point literal.</p>
|
||
<p>This constructor is similar to those like <code>Literal::i8_unsuffixed</code> where
|
||
the float's value is emitted directly into the token but no suffix is
|
||
used, so it may be inferred to be a <code>f64</code> later in the compiler.
|
||
Literals created from negative numbers may not survive rountrips through
|
||
<code>TokenStream</code> or strings and may be broken into two tokens (<code>-</code> and
|
||
positive literal).</p>
|
||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<p>This function requires that the specified float is finite, for example
|
||
if it is infinity or NaN this function will panic.</p>
|
||
</div><h4 id='method.f32_suffixed' class="method"><span id='f32_suffixed.v' class='invisible'><code>pub fn <a href='#method.f32_suffixed' class='fnname'>f32_suffixed</a>(f: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#992-995' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.string' class="method"><span id='string.v' class='invisible'><code>pub fn <a href='#method.string' class='fnname'>string</a>(string: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#997-999' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.character' class="method"><span id='character.v' class='invisible'><code>pub fn <a href='#method.character' class='fnname'>character</a>(ch: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#1001-1003' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.byte_string' class="method"><span id='byte_string.v' class='invisible'><code>pub fn <a href='#method.byte_string' class='fnname'>byte_string</a>(s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#1005-1007' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.span' class="method"><span id='span.v' class='invisible'><code>pub fn <a href='#method.span' class='fnname'>span</a>(&self) -> <a class="struct" href="../proc_macro2/struct.Span.html" title="struct proc_macro2::Span">Span</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#1009-1011' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.set_span' class="method"><span id='set_span.v' class='invisible'><code>pub fn <a href='#method.set_span' class='fnname'>set_span</a>(&mut self, span: <a class="struct" href="../proc_macro2/struct.Span.html" title="struct proc_macro2::Span">Span</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#1013-1015' title='goto source code'>[src]</a></span></h4>
|
||
</div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-From%3CLiteral%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a>> for <a class="enum" href="../proc_macro2/enum.TokenTree.html" title="enum proc_macro2::TokenTree">TokenTree</a></code><a href='#impl-From%3CLiteral%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#452-456' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(g: <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a>) -> <a class="enum" href="../proc_macro2/enum.TokenTree.html" title="enum proc_macro2::TokenTree">TokenTree</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#453-455' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#877' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#877' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>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="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#1018-1022' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>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="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#1019-1021' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><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><h3 id='impl-Display' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../proc_macro2/struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#1024-1028' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.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="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#1025-1027' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
||
</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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "proc_macro2";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |