Struct ItemFnMut

pub struct ItemFnMut<'a> { /* private fields */ }

Handle to a an item inserted into a module which allows for mutation of item metadata.

This is returned by methods which insert meta items, such as:

• Module::raw_fn.
• Module::function.
• Module::associated_function.

While this is also returned by *_meta inserting functions, it is instead recommended that you make use of the appropriate macro to capture doc comments instead:

• Module::macro_meta.
• Module::function_meta.

Implementations

impl ItemFnMut<'_>

pub fn docs( self, docs: impl IntoIterator<Item: AsRef<str>>, ) -> Result<Self, ContextError>

Set documentation for an inserted item.

This completely replaces any existing documentation.

pub fn is_async(self, is_async: bool) -> Self

Mark the given item as an async function.

pub fn deprecated( self, deprecated: impl AsRef<str>, ) -> Result<Self, ContextError>

Mark the given item as deprecated.

pub fn args(self, args: usize) -> Self

Indicate the number of arguments this function accepts.

pub fn return_type<T>(self) -> Result<Self, ContextError>

where T: MaybeTypeOf,

Set the kind of return type.

pub fn argument_types<A>(self) -> Result<Self, ContextError>

where A: FunctionArgs,

Set argument types.

Trait Implementations

impl Debug for ItemFnMut<'_>

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

Formats the value using the given formatter.