Struct rustc_expand::proc_macro_server::Rustc

source · [−]

pub(crate) struct Rustc<'a, 'b> {
    ecx: &'a mut ExtCtxt<'b>,
    def_site: Span,
    call_site: Span,
    mixed_site: Span,
    krate: CrateNum,
    rebased_spans: FxHashMap<usize, Span>,
}

Fields

ecx: &'a mut ExtCtxt<'b>def_site: Spancall_site: Spanmixed_site: Spankrate: CrateNumrebased_spans: FxHashMap<usize, Span>

Implementations

source

fn lit(
 &mut self,
 kind: LitKind,
 symbol: Symbol,
 suffix: Option<Symbol>
) -> Literal

Trait Implementations

source

impl Diagnostic for Rustc<'_, '_>

source

fn new(
    &mut self,
    level: Level,
    msg: &str,
    spans: Self::MultiSpan
) -> Self::Diagnostic

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn sub(
    &mut self,
    diag: &mut Self::Diagnostic,
    level: Level,
    msg: &str,
    spans: Self::MultiSpan
)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn emit(&mut self, diag: Self::Diagnostic)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn drop(&mut self, self_: Self::Diagnostic)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

impl FreeFunctions for Rustc<'_, '_>

source

fn track_env_var(&mut self, var: &str, value: Option<&str>)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn track_path(&mut self, path: &str)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn drop(&mut self, self_: Self::FreeFunctions)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

impl Group for Rustc<'_, '_>

source

fn new(
 &mut self,
 delimiter: Delimiter,
 stream: Option<Self::TokenStream>
) -> Self::Group

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn delimiter(&mut self, group: &Self::Group) -> Delimiter

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn stream(&mut self, group: &Self::Group) -> Self::TokenStream

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn span(&mut self, group: &Self::Group) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn span_open(&mut self, group: &Self::Group) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn span_close(&mut self, group: &Self::Group) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn set_span(&mut self, group: &mut Self::Group, span: Self::Span)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn drop(&mut self, self_: Self::Group)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn clone(&mut self, self_: &Self::Group) -> Self::Group

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

impl Ident for Rustc<'_, '_>

source

fn new(&mut self, string: &str, span: Self::Span, is_raw: bool) -> Self::Ident

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn span(&mut self, ident: Self::Ident) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn with_span(&mut self, ident: Self::Ident, span: Self::Span) -> Self::Ident

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

impl Literal for Rustc<'_, '_>

source

fn from_str(&mut self, s: &str) -> Result<Self::Literal, ()>

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn to_string(&mut self, literal: &Self::Literal) -> String

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn debug_kind(&mut self, literal: &Self::Literal) -> String

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn symbol(&mut self, literal: &Self::Literal) -> String

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn suffix(&mut self, literal: &Self::Literal) -> Option<String>

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn integer(&mut self, n: &str) -> Self::Literal

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn typed_integer(&mut self, n: &str, kind: &str) -> Self::Literal

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn float(&mut self, n: &str) -> Self::Literal

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn f32(&mut self, n: &str) -> Self::Literal

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn f64(&mut self, n: &str) -> Self::Literal

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn string(&mut self, string: &str) -> Self::Literal

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn character(&mut self, ch: char) -> Self::Literal

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn byte_string(&mut self, bytes: &[u8]) -> Self::Literal

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn span(&mut self, literal: &Self::Literal) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn set_span(&mut self, literal: &mut Self::Literal, span: Self::Span)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn subspan(
 &mut self,
 literal: &Self::Literal,
 start: Bound<usize>,
 end: Bound<usize>
) -> Option<Self::Span>

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn drop(&mut self, self_: Self::Literal)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn clone(&mut self, self_: &Self::Literal) -> Self::Literal

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

impl MultiSpan for Rustc<'_, '_>

source

fn new(&mut self) -> Self::MultiSpan

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn push(&mut self, spans: &mut Self::MultiSpan, span: Self::Span)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn drop(&mut self, self_: Self::MultiSpan)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

impl Punct for Rustc<'_, '_>

source

fn new(&mut self, ch: char, spacing: Spacing) -> Self::Punct

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn as_char(&mut self, punct: Self::Punct) -> char

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn spacing(&mut self, punct: Self::Punct) -> Spacing

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn span(&mut self, punct: Self::Punct) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn with_span(&mut self, punct: Self::Punct, span: Self::Span) -> Self::Punct

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

impl SourceFile for Rustc<'_, '_>

source

fn eq(&mut self, file1: &Self::SourceFile, file2: &Self::SourceFile) -> bool

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn path(&mut self, file: &Self::SourceFile) -> String

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn is_real(&mut self, file: &Self::SourceFile) -> bool

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn drop(&mut self, self_: Self::SourceFile)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn clone(&mut self, self_: &Self::SourceFile) -> Self::SourceFile

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

impl Span for Rustc<'_, '_>

source

fn save_span(&mut self, span: Self::Span) -> usize

🔬 This is a nightly-only experimental API. (proc_macro_internals)

Saves the provided span into the metadata of the crate we are currently compiling, which must be a proc-macro crate. This id can be passed to recover_proc_macro_span when our current crate is run as a proc-macro.

Let’s suppose that we have two crates - my_client and my_proc_macro. The my_proc_macro crate contains a procedural macro my_macro, which is implemented as: quote! { "hello" }

When we compile my_proc_macro, we will execute the quote proc-macro. This will save the span of “hello” into the metadata of my_proc_macro. As a result, the body of my_proc_macro (after expansion) will end up containing a call that looks like this: proc_macro::Ident::new("hello", proc_macro::Span::recover_proc_macro_span(0))

where 0 is the id returned by this function. When my_proc_macro executes (during the compilation of my_client), the call to recover_proc_macro_span will load the corresponding span from the metadata of my_proc_macro (which we have access to, since we’ve loaded my_proc_macro from disk in order to execute it). In this way, we have obtained a span pointing into my_proc_macro

source

fn debug(&mut self, span: Self::Span) -> String

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn def_site(&mut self) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn call_site(&mut self) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn mixed_site(&mut self) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn source_file(&mut self, span: Self::Span) -> Self::SourceFile

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn parent(&mut self, span: Self::Span) -> Option<Self::Span>

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn source(&mut self, span: Self::Span) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn start(&mut self, span: Self::Span) -> LineColumn

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn end(&mut self, span: Self::Span) -> LineColumn

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn before(&mut self, span: Self::Span) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn after(&mut self, span: Self::Span) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn join(&mut self, first: Self::Span, second: Self::Span) -> Option<Self::Span>

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn resolved_at(&mut self, span: Self::Span, at: Self::Span) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn source_text(&mut self, span: Self::Span) -> Option<String>

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn recover_proc_macro_span(&mut self, id: usize) -> Self::Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

impl TokenStream for Rustc<'_, '_>

source

fn is_empty(&mut self, stream: &Self::TokenStream) -> bool

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn from_str(&mut self, src: &str) -> Self::TokenStream

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn to_string(&mut self, stream: &Self::TokenStream) -> String

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn expand_expr(
&mut self,
stream: &Self::TokenStream
) -> Result<Self::TokenStream, ()>

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn from_token_tree(
&mut self,
tree: TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>
) -> Self::TokenStream

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn concat_trees(
 &mut self,
 base: Option<Self::TokenStream>,
 trees: Vec<TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>>
) -> Self::TokenStream

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn concat_streams(
 &mut self,
 base: Option<Self::TokenStream>,
 streams: Vec<Self::TokenStream>
) -> Self::TokenStream

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn into_trees(
&mut self,
stream: Self::TokenStream
) -> Vec<TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>>

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn drop(&mut self, self_: Self::TokenStream)

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

fn clone(&mut self, self_: &Self::TokenStream) -> Self::TokenStream

🔬 This is a nightly-only experimental API. (proc_macro_internals)

source

impl Types for Rustc<'_, '_>

type FreeFunctions = FreeFunctions

🔬 This is a nightly-only experimental API. (proc_macro_internals)

type TokenStream = TokenStream

🔬 This is a nightly-only experimental API. (proc_macro_internals)

type Group = Group

🔬 This is a nightly-only experimental API. (proc_macro_internals)

type Punct = Punct

🔬 This is a nightly-only experimental API. (proc_macro_internals)

type Ident = Ident

🔬 This is a nightly-only experimental API. (proc_macro_internals)

type Literal = Literal

🔬 This is a nightly-only experimental API. (proc_macro_internals)

type SourceFile = Rc<SourceFile>

🔬 This is a nightly-only experimental API. (proc_macro_internals)

type MultiSpan = Vec<Span, Global>

🔬 This is a nightly-only experimental API. (proc_macro_internals)

type Diagnostic = Diagnostic

🔬 This is a nightly-only experimental API. (proc_macro_internals)

type Span = Span

🔬 This is a nightly-only experimental API. (proc_macro_internals)

Auto Trait Implementations

impl<'a, 'b> !RefUnwindSafe for Rustc<'a, 'b>

impl<'a, 'b> !Send for Rustc<'a, 'b>

impl<'a, 'b> !Sync for Rustc<'a, 'b>

impl<'a, 'b> Unpin for Rustc<'a, 'b> where
'b: 'a,

impl<'a, 'b> !UnwindSafe for Rustc<'a, 'b>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 72 bytes

Struct rustc_expand::proc_macro_server::Rustc

Fields

Implementations

impl<'a, 'b> Rustc<'a, 'b>

pub fn new(ecx: &'a mut ExtCtxt<'b>) -> Self

fn sess(&self) -> &ParseSess

fn lit( &mut self, kind: LitKind, symbol: Symbol, suffix: Option<Symbol>) -> Literal

Trait Implementations

impl Diagnostic for Rustc<'_, '_>

fn new( &mut self, level: Level, msg: &str, spans: Self::MultiSpan) -> Self::Diagnostic

fn sub( &mut self, diag: &mut Self::Diagnostic, level: Level, msg: &str, spans: Self::MultiSpan)

fn emit(&mut self, diag: Self::Diagnostic)

fn drop(&mut self, self_: Self::Diagnostic)

impl FreeFunctions for Rustc<'_, '_>

fn track_env_var(&mut self, var: &str, value: Option<&str>)

fn track_path(&mut self, path: &str)

fn drop(&mut self, self_: Self::FreeFunctions)

impl Group for Rustc<'_, '_>

fn new( &mut self, delimiter: Delimiter, stream: Option<Self::TokenStream>) -> Self::Group

fn delimiter(&mut self, group: &Self::Group) -> Delimiter

fn stream(&mut self, group: &Self::Group) -> Self::TokenStream

fn span(&mut self, group: &Self::Group) -> Self::Span

fn span_open(&mut self, group: &Self::Group) -> Self::Span

fn span_close(&mut self, group: &Self::Group) -> Self::Span

fn set_span(&mut self, group: &mut Self::Group, span: Self::Span)

fn drop(&mut self, self_: Self::Group)

fn clone(&mut self, self_: &Self::Group) -> Self::Group

impl Ident for Rustc<'_, '_>

fn new(&mut self, string: &str, span: Self::Span, is_raw: bool) -> Self::Ident

fn span(&mut self, ident: Self::Ident) -> Self::Span

fn with_span(&mut self, ident: Self::Ident, span: Self::Span) -> Self::Ident

impl Literal for Rustc<'_, '_>

fn from_str(&mut self, s: &str) -> Result<Self::Literal, ()>

fn to_string(&mut self, literal: &Self::Literal) -> String

fn debug_kind(&mut self, literal: &Self::Literal) -> String

fn symbol(&mut self, literal: &Self::Literal) -> String

fn suffix(&mut self, literal: &Self::Literal) -> Option<String>

fn integer(&mut self, n: &str) -> Self::Literal

fn typed_integer(&mut self, n: &str, kind: &str) -> Self::Literal

fn float(&mut self, n: &str) -> Self::Literal

fn f32(&mut self, n: &str) -> Self::Literal

fn f64(&mut self, n: &str) -> Self::Literal

fn string(&mut self, string: &str) -> Self::Literal

fn character(&mut self, ch: char) -> Self::Literal

fn byte_string(&mut self, bytes: &[u8]) -> Self::Literal

fn span(&mut self, literal: &Self::Literal) -> Self::Span

fn set_span(&mut self, literal: &mut Self::Literal, span: Self::Span)

fn subspan( &mut self, literal: &Self::Literal, start: Bound<usize>, end: Bound<usize>) -> Option<Self::Span>

fn drop(&mut self, self_: Self::Literal)

fn clone(&mut self, self_: &Self::Literal) -> Self::Literal

impl MultiSpan for Rustc<'_, '_>

fn new(&mut self) -> Self::MultiSpan

fn push(&mut self, spans: &mut Self::MultiSpan, span: Self::Span)

fn drop(&mut self, self_: Self::MultiSpan)

impl Punct for Rustc<'_, '_>

fn new(&mut self, ch: char, spacing: Spacing) -> Self::Punct

fn as_char(&mut self, punct: Self::Punct) -> char

fn spacing(&mut self, punct: Self::Punct) -> Spacing

fn span(&mut self, punct: Self::Punct) -> Self::Span

fn with_span(&mut self, punct: Self::Punct, span: Self::Span) -> Self::Punct

impl SourceFile for Rustc<'_, '_>

fn eq(&mut self, file1: &Self::SourceFile, file2: &Self::SourceFile) -> bool

fn path(&mut self, file: &Self::SourceFile) -> String

fn is_real(&mut self, file: &Self::SourceFile) -> bool

fn drop(&mut self, self_: Self::SourceFile)

fn clone(&mut self, self_: &Self::SourceFile) -> Self::SourceFile

impl Span for Rustc<'_, '_>

fn save_span(&mut self, span: Self::Span) -> usize

fn debug(&mut self, span: Self::Span) -> String

fn def_site(&mut self) -> Self::Span

fn call_site(&mut self) -> Self::Span

fn mixed_site(&mut self) -> Self::Span

fn source_file(&mut self, span: Self::Span) -> Self::SourceFile

fn parent(&mut self, span: Self::Span) -> Option<Self::Span>

fn source(&mut self, span: Self::Span) -> Self::Span

fn start(&mut self, span: Self::Span) -> LineColumn

fn end(&mut self, span: Self::Span) -> LineColumn

fn before(&mut self, span: Self::Span) -> Self::Span

fn after(&mut self, span: Self::Span) -> Self::Span

fn join(&mut self, first: Self::Span, second: Self::Span) -> Option<Self::Span>

fn lit(
&mut self,
kind: LitKind,
symbol: Symbol,
suffix: Option<Symbol>
) -> Literal

fn new(
&mut self,
level: Level,
msg: &str,
spans: Self::MultiSpan
) -> Self::Diagnostic

fn sub(
&mut self,
diag: &mut Self::Diagnostic,
level: Level,
msg: &str,
spans: Self::MultiSpan
)

fn new(
&mut self,
delimiter: Delimiter,
stream: Option<Self::TokenStream>
) -> Self::Group

fn subspan(
&mut self,
literal: &Self::Literal,
start: Bound<usize>,
end: Bound<usize>
) -> Option<Self::Span>

fn expand_expr(
&mut self,
stream: &Self::TokenStream
) -> Result<Self::TokenStream, ()>

fn from_token_tree(
&mut self,
tree: TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>
) -> Self::TokenStream

fn concat_trees(
&mut self,
base: Option<Self::TokenStream>,
trees: Vec<TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>>
) -> Self::TokenStream

fn concat_streams(
&mut self,
base: Option<Self::TokenStream>,
streams: Vec<Self::TokenStream>
) -> Self::TokenStream

fn into_trees(
&mut self,
stream: Self::TokenStream
) -> Vec<TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>>

impl<'a, 'b> Unpin for Rustc<'a, 'b> where
'b: 'a,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,