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

use crate::compiler::prelude::*;
use nom::AsBytes;
use std::str;

fn decode_base16(value: &Value) -> Resolved {
    match base16::decode(&value.try_bytes_utf8_lossy()?.to_string()) {
        Ok(s) => Ok((s.as_bytes()).into()),
        Err(_) => Err("unable to decode value to base16".into()),
    }
}

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

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

    fn usage(&self) -> &'static str {
        "Decodes the `value` (a [Base16](https://en.wikipedia.org/wiki/Hexadecimal) string) into its original string."
    }

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

    fn internal_failure_reasons(&self) -> &'static [&'static str] {
        &["`value` isn't a valid encoded Base16 string."]
    }

    fn return_kind(&self) -> u16 {
        kind::BYTES
    }

    fn parameters(&self) -> &'static [Parameter] {
        const PARAMETERS: &[Parameter] = &[Parameter::required(
            "value",
            kind::BYTES,
            "The [Base16](https://en.wikipedia.org/wiki/Hexadecimal) data to decode.",
        )];
        PARAMETERS
    }

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

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

    fn examples(&self) -> &'static [Example] {
        &[
            example! {
                title: "Decode Base16 data",
                source: r#"decode_base16!("736F6D6520737472696E672076616C7565")"#,
                result: Ok("some string value"),
            },
            example! {
                title: "Decode longer Base16 data",
                source: r#"decode_base16!("796f752068617665207375636365737366756c6c79206465636f646564206d65")"#,
                result: Ok("you have successfully decoded me"),
            },
        ]
    }
}

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

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

        decode_base16(&value)
    }

    fn type_def(&self, _: &state::TypeState) -> TypeDef {
        // Always fallible due to the possibility of decoding errors that VRL can't detect in `base16`
        TypeDef::bytes().fallible()
    }
}

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

    test_function![
        decode_base16 => DecodeBase16;

        standard {
            args: func_args![value: value!("736F6D652B3D737472696E672F76616C7565")],
            want: Ok(value!("some+=string/value")),
            tdef: TypeDef::bytes().fallible(),
        }
    ];
}