vrl 0.32.0

Vector Remap Language
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

use crate::compiler::prelude::*;

fn abs(value: Value) -> Resolved {
    match value {
        Value::Float(f) => Ok(Value::from_f64_or_zero(f.abs())),
        Value::Integer(i) => Ok(Value::from(i.abs())),
        value => Err(ValueError::Expected {
            got: value.kind(),
            expected: Kind::float() | Kind::integer(),
        }
        .into()),
    }
}

#[derive(Clone, Copy, Debug)]
pub struct Abs;

impl Function for Abs {
    fn identifier(&self) -> &'static str {
        "abs"
    }

    fn usage(&self) -> &'static str {
        "Computes the absolute value of `value`."
    }

    fn category(&self) -> &'static str {
        Category::Number.as_ref()
    }

    fn return_kind(&self) -> u16 {
        kind::INTEGER | kind::FLOAT
    }

    fn return_rules(&self) -> &'static [&'static str] {
        &["Returns the absolute value."]
    }

    fn parameters(&self) -> &'static [Parameter] {
        const PARAMETERS: &[Parameter] = &[Parameter::required(
            "value",
            kind::FLOAT | kind::INTEGER,
            "The number to calculate the absolute value.",
        )];
        PARAMETERS
    }

    fn compile(
        &self,
        _state: &state::TypeState,
        _ctx: &mut FunctionCompileContext,
        arguments: ArgumentList,
    ) -> Compiled {
        let value = arguments.required("value");

        Ok(AbsFn { value }.as_expr())
    }

    fn examples(&self) -> &'static [Example] {
        &[
            example! {
                title: "Computes the absolute value of an integer",
                source: "abs(-42)",
                result: Ok("42"),
            },
            example! {
                title: "Computes the absolute value of a float",
                source: "abs(-42.2)",
                result: Ok("42.2"),
            },
            example! {
                title: "Computes the absolute value of a positive integer",
                source: "abs(10)",
                result: Ok("10"),
            },
        ]
    }
}

#[derive(Clone, Debug)]
struct AbsFn {
    value: Box<dyn Expression>,
}

impl FunctionExpression for AbsFn {
    fn resolve(&self, ctx: &mut Context) -> Resolved {
        let value = self.value.resolve(ctx)?;

        abs(value)
    }

    fn type_def(&self, state: &state::TypeState) -> TypeDef {
        match Kind::from(self.value.type_def(state)) {
            v if v.is_float() || v.is_integer() => v.into(),
            _ => Kind::integer().or_float().into(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::value;

    test_function![
        abs => Abs;

        integer_negative {
            args: func_args![value: value!(-42)],
            want: Ok(value!(42)),
            tdef: TypeDef::integer(),
        }

        integer_positive {
            args: func_args![value: value!(42)],
            want: Ok(value!(42)),
            tdef: TypeDef::integer(),
        }

        float_negative {
            args: func_args![value: value!(-42.2)],
            want: Ok(value!(42.2)),
            tdef: TypeDef::float(),
        }

        float_positive {
            args: func_args![value: value!(42.2)],
            want: Ok(value!(42.2)),
            tdef: TypeDef::float(),
        }
    ];
}