Struct proc_macro2::Literal [−][src]
A literal string ("hello"
), byte string (b"hello"
), character ('a'
),
byte character (b'a'
), an integer or floating point number with or without
a suffix (1
, 1u8
, 2.3
, 2.3f32
).
Boolean literals like true
and false
do not belong here, they are
Ident
s.
Implementations
impl Literal
[src]
pub fn u8_suffixed(n: u8) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn u16_suffixed(n: u16) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn u32_suffixed(n: u32) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn u64_suffixed(n: u64) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn u128_suffixed(n: u128) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn usize_suffixed(n: usize) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn i8_suffixed(n: i8) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn i16_suffixed(n: i16) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn i32_suffixed(n: i32) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn i64_suffixed(n: i64) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn i128_suffixed(n: i128) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn isize_suffixed(n: isize) -> Literal
[src]
Creates a new suffixed integer literal with the specified value.
This function will create an integer like 1u32
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 roundtrips through TokenStream
or strings and may be
broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn u8_unsuffixed(n: u8) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn u16_unsuffixed(n: u16) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn u32_unsuffixed(n: u32) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn u64_unsuffixed(n: u64) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn u128_unsuffixed(n: u128) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn usize_unsuffixed(n: usize) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn i8_unsuffixed(n: i8) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn i16_unsuffixed(n: i16) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn i32_unsuffixed(n: i32) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn i64_unsuffixed(n: i64) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn i128_unsuffixed(n: i128) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn isize_unsuffixed(n: isize) -> Literal
[src]
Creates a new unsuffixed integer literal with the specified value.
This function will create an integer like 1
where the integer
value specified is the first part of the token. No suffix is
specified on this token, meaning that invocations like
Literal::i8_unsuffixed(1)
are equivalent to
Literal::u32_unsuffixed(1)
. Literals created from negative numbers
may not survive roundtrips through TokenStream
or strings and may
be broken into two tokens (-
and positive literal).
Literals created through this method have the Span::call_site()
span by default, which can be configured with the set_span
method
below.
pub fn f64_unsuffixed(f: f64) -> Literal
[src]
Creates a new unsuffixed floating-point literal.
This constructor is similar to those like Literal::i8_unsuffixed
where
the float’s value is emitted directly into the token but no suffix is
used, so it may be inferred to be a f64
later in the compiler.
Literals created from negative numbers may not survive rountrips through
TokenStream
or strings and may be broken into two tokens (-
and
positive literal).
Panics
This function requires that the specified float is finite, for example if it is infinity or NaN this function will panic.
pub fn f64_suffixed(f: f64) -> Literal
[src]
Creates a new suffixed floating-point literal.
This constructor will create a literal like 1.0f64
where the value
specified is the preceding part of the token and f64
is the suffix of
the token. This token will always be inferred to be an f64
in the
compiler. Literals created from negative numbers may not survive
rountrips through TokenStream
or strings and may be broken into two
tokens (-
and positive literal).
Panics
This function requires that the specified float is finite, for example if it is infinity or NaN this function will panic.
pub fn f32_unsuffixed(f: f32) -> Literal
[src]
Creates a new unsuffixed floating-point literal.
This constructor is similar to those like Literal::i8_unsuffixed
where
the float’s value is emitted directly into the token but no suffix is
used, so it may be inferred to be a f64
later in the compiler.
Literals created from negative numbers may not survive rountrips through
TokenStream
or strings and may be broken into two tokens (-
and
positive literal).
Panics
This function requires that the specified float is finite, for example if it is infinity or NaN this function will panic.
pub fn f32_suffixed(f: f32) -> Literal
[src]
Creates a new suffixed floating-point literal.
This constructor will create a literal like 1.0f32
where the value
specified is the preceding part of the token and f32
is the suffix of
the token. This token will always be inferred to be an f32
in the
compiler. Literals created from negative numbers may not survive
rountrips through TokenStream
or strings and may be broken into two
tokens (-
and positive literal).
Panics
This function requires that the specified float is finite, for example if it is infinity or NaN this function will panic.
pub fn string(string: &str) -> Literal
[src]
String literal.
pub fn character(ch: char) -> Literal
[src]
Character literal.
pub fn byte_string(s: &[u8]) -> Literal
[src]
Byte string literal.
pub fn span(&self) -> Span
[src]
Returns the span encompassing this literal.
pub fn set_span(&mut self, span: Span)
[src]
Configures the span associated for this literal.
pub fn subspan<R: RangeBounds<usize>>(&self, range: R) -> Option<Span>
[src]
Returns a Span
that is a subset of self.span()
containing only
the source bytes in range range
. Returns None
if the would-be
trimmed span is outside the bounds of self
.
Warning: the underlying proc_macro::Literal::subspan
method is
nightly-only. When called from within a procedural macro not using a
nightly compiler, this method will always return None
.
Trait Implementations
impl Clone for Literal
[src]
impl Debug for Literal
[src]
impl Display for Literal
[src]
impl From<Literal> for TokenTree
[src]
Auto Trait Implementations
impl RefUnwindSafe for Literal
impl !Send for Literal
impl !Sync for Literal
impl Unpin for Literal
impl UnwindSafe for Literal
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,