Skip to main content

shape_builtin

Attribute Macro shape_builtin 

Source
#[shape_builtin]
Expand description

Attribute macro for Shape builtin functions.

Extracts metadata from doc comments and generates a METADATA_<NAME> constant.

§Usage

/// Calculate Simple Moving Average
///
/// # Parameters
/// * `series: Series` - Input price series
/// * `period: Number` - Lookback period
///
/// # Returns
/// `Series` - Smoothed series
///
/// # Example
/// ```shape
/// sma(series("close"), 20)
/// ```
#[shape_builtin(category = "Indicator")]
pub fn eval_sma(args: Vec<Value>, ctx: &mut ExecutionContext) -> Result<Value> {
    // implementation
}