pine-builtins 0.2.2

Built-in functions and namespaces for the Pine Script interpreter.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

//! The `fill(id1, id2, color, title, transp)` global function.
//!
//! Fills the area between two plots or hlines. The ids come from `plot`/`hline`
//! (which may be `na`); the fill is recorded via [`FillOutput`].

use pine_builtin_macro::BuiltinFunction;
use pine_core::{Color, FillObject, FillOutput, PineOutput};
use pine_interpreter::{Interpreter, RuntimeError, Value};

/// fill(id1, id2, color, title, transp, ...)
#[derive(BuiltinFunction)]
#[builtin(name = "fill", output = FillOutput)]
struct Fill {
    #[arg(default = None)]
    id1: Option<f64>,
    #[arg(default = None)]
    id2: Option<f64>,
    #[arg(default = None)]
    color: Option<Color>,
    #[arg(default = "")]
    title: String,
    #[arg(default = None)]
    transp: Option<f64>,
}

impl Fill {
    fn execute<O: PineOutput + FillOutput>(
        &self,
        ctx: &mut Interpreter<O>,
    ) -> Result<Value<O>, RuntimeError> {
        let _ = self.transp;
        ctx.output.add_fill(FillObject {
            id1: self.id1.map(|x| x as usize),
            id2: self.id2.map(|x| x as usize),
            color: self.color.clone(),
            title: self.title.clone(),
        });
        Ok(Value::Na)
    }
}

/// The `fill` global function value.
pub fn register<O: PineOutput + FillOutput>() -> Value<O> {
    Fill::builtin_value::<O>()
}