module

Attribute Macro module 

Source
#[module]
Expand description

Macro used to annotate a module with metadata.

ThIs defines a local function module_meta which can be used in conjunction with Module::from_meta to construct a module with a given item and captured documentation.

ยงExamples

use rune::{ContextError, Module};

/// Utilities for working with colors.
#[rune::module(::color)]
pub fn module() -> Result<Module, ContextError> {
    let mut m = Module::from_meta(module__meta)?;

    // Populate module.

    Ok(m)
}