Struct Context

pub struct Context<'a, T> { /* private fields */ }

used to lint, expand and capture

a context might not have data in it (eg. if parsing the data failed), so calling the lint and expand functions does not guarantee the Lints and Expands actually run

Implementations

impl<'a, T> Context<'a, T>

pub fn new(collector: &'a mut Collector, data: T) -> Self

create a new context with the data

pub fn new_by_ref(collector: &'a mut Collector, data: &'a T) -> Self

create a new context with the data passed by reference

pub fn new_empty(collector: &'a mut Collector) -> Self

create a new context without any data in it

pub fn new_parse(collector: &'a mut Collector, data: TokenStream) -> Self

where T: Parse,

try to parse the data from a proc_macro::TokenStream

if parsing the data fails the error is reported to the collector

pub fn new_parse2(collector: &'a mut Collector, data: TokenStream) -> Self

where T: Parse,

try to parse the data from a proc_macro2::TokenStream

if parsing the data fails the error is reported to the collector

pub fn lint<L: Lint<T>>(&mut self, lint: &L) -> bool

lint the macro input

returns true if the lint ran without reporting an error

pub fn expand(&mut self, expand: &impl Expand<T>)

expand the macro and add the result to the collector

pub fn capture<E: Expand<T>>(&mut self, expand: &E) -> Option<E::Output>

expand the macro and return the output