Struct rustc_expand::proc_macro_server::Rustc

pub(crate) struct Rustc<'a> {
    resolver: &'a dyn ResolverExpand,
    sess: &'a ParseSess,
    def_site: Span,
    call_site: Span,
    mixed_site: Span,
    span_debug: bool,
    krate: CrateNum,
    rebased_spans: FxHashMap<usize, Span>,
}

Fields

resolver: &'a dyn ResolverExpand

sess: &'a ParseSess

def_site: Span

call_site: Span

mixed_site: Span

span_debug: bool

krate: CrateNum

rebased_spans: FxHashMap<usize, Span>

Implementations

impl<'a> Rustc<'a>

pub fn new(cx: &'a ExtCtxt<'_>) -> Self

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

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

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)

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

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

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

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

impl FreeFunctions for Rustc<'_>

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

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

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

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

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

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

impl Group for Rustc<'_>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl Ident for Rustc<'_>

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

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

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

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

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

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

impl Literal for Rustc<'_>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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)

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

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

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

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

impl MultiSpan for Rustc<'_>

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

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

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

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

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

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

impl Punct for Rustc<'_>

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

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

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

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

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

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

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

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

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

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

impl SourceFile for Rustc<'_>

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

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

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

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

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

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

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

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

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

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

impl Span for Rustc<'_>

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 containg 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl TokenStream for Rustc<'_>

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

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

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

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

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

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

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

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

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)

fn into_iter(&mut self, stream: Self::TokenStream) -> Self::TokenStreamIter

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

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

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

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

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

impl TokenStreamBuilder for Rustc<'_>

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

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

fn push(
    &mut self,
    builder: &mut Self::TokenStreamBuilder,
    stream: Self::TokenStream
)

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

fn build(&mut self, builder: Self::TokenStreamBuilder) -> Self::TokenStream

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

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

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

impl TokenStreamIter for Rustc<'_>

fn next(
    &mut self,
    iter: &mut Self::TokenStreamIter
) -> Option<TokenTree<Self::Group, Self::Punct, Self::Ident, Self::Literal>>

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

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

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

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

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

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 TokenStreamBuilder = TokenStreamBuilder

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

type TokenStreamIter = TokenStreamIter

🔬 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 = Lrc<SourceFile>

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

type MultiSpan = Vec<Span>

🔬 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)

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: 88 bytes