Struct WrappedFn

pub struct WrappedFn {
    pub function: ItemFn,
    pub pre_code: Option<TokenStream>,
    pub post_code: Option<TokenStream>,
    pub wrapper_ident: Ident,
    pub result_ident: Ident,
}

Function that can have code inserted before and after the rest of the function executes. Can be constructed with syn::parse() and other variations of parsing from the syn crate.

Example:

let mut function = parse_macro_input!(token_stream as WrappedFn);

Code that runs before the function can be set using the set_pre_code() method.

Example:

function.set_pre_code(quote!{ println!("Hi at the start :)"); });

Code that runs after the function can be set using the set_post_code() method.

Example:

function.set_post_code(quote!{ println!("Hi at the end :)"); });

Fields

function: ItemFn

syn::ItemFn that contains all of the data of the original function, including the code inside, the function signature, any attributes, etc.

pre_code: Option<TokenStream>

Contains code that gets run before the rest of the function.

post_code: Option<TokenStream>

Contains code that gets run after the rest of the function.

wrapper_ident: Ident

Identifier token for the closure that wraps all of the original code from the wrapped function. wrapper by default.

result_ident: Ident

Identifier token for the variable that holds the return value of the wrapped function. result by default.

Implementations

impl WrappedFn

pub fn set_pre_code(&mut self, pre_code: TokenStream)

Sets the code that gets run before the rest of the function executes.

pub fn set_post_code(&mut self, post_code: TokenStream)

Sets the code that gets run after the rest of the function executes.

pub fn remove_pre_code(&mut self)

Removes any code that was going to be added before the rest of the function.

pub fn remove_post_code(&mut self)

Removes any code that was going to be added after the rest of the function.

pub fn set_wrapper_ident(&mut self, ident: &str)

Changes the identifier for the closure that wraps the code of the original function (wrapper by default).

pub fn set_result_ident(&mut self, ident: &str)

Changes the identifier for the variable that holds the value that the function returns (result by default).

Trait Implementations

impl Clone for WrappedFn

fn clone(&self) -> WrappedFn

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WrappedFn

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&WrappedFn> for ItemFn

Allows WrappedFns to be converted to syn::ItemFns for easier use in procedural macros.

fn from(function: &WrappedFn) -> Self

Converts a WrappedFn into a syn::ItemFn.

impl From<&WrappedFn> for TokenStream

Allows WrappedFns to be converted into proc_macro2::TokenStreams for easier use in procedural attribute macros.

fn from(function: &WrappedFn) -> Self

Converts a WrappedFn into a proc_macro2::TokenStream.

impl From<WrappedFn> for ItemFn

Allows WrappedFns to be converted to syn::ItemFns for easier use in procedural macros.

fn from(function: WrappedFn) -> Self

Converts a WrappedFn into a syn::ItemFn.

impl From<WrappedFn> for TokenStream

Allows WrappedFns to be converted into proc_macro2::TokenStreams for easier use in procedural attribute macros.

fn from(function: WrappedFn) -> Self

Converts a WrappedFn into a proc_macro2::TokenStream.

impl Parse for WrappedFn

Main way to construct a WrappedFn. Can be constructed using syn::parse_macro_input like this:

let mut function = parse_macro_input!(token_stream as WrappedFn);

fn parse(input: ParseStream<'_>) -> Result<Self>

Constructs a WrappedFn from a syn::ParseStream.

impl ToTokens for WrappedFn

Allows WrappedFns to be easily appended to and converted to proc_macro2::TokenStreams.

fn to_tokens(&self, tokens: &mut TokenStream)

Adds a WrappedFn to the end of a proc_macro2::TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.