vrl 0.32.0

Vector Remap Language
Documentation
use crate::value::Value;
use chrono::{TimeZone, Utc};
use ordered_float::NotNan;
use regex::Regex;

use crate::value;

pub const BYTES: u16 = 1 << 1;
pub const INTEGER: u16 = 1 << 2;
pub const FLOAT: u16 = 1 << 3;
pub const BOOLEAN: u16 = 1 << 4;
pub const OBJECT: u16 = 1 << 5;
pub const ARRAY: u16 = 1 << 6;
pub const TIMESTAMP: u16 = 1 << 7;
pub const REGEX: u16 = 1 << 8;
pub const NULL: u16 = 1 << 9;
pub const UNDEFINED: u16 = 1 << 10;

pub const ANY: u16 =
    BYTES | INTEGER | FLOAT | BOOLEAN | OBJECT | ARRAY | TIMESTAMP | REGEX | NULL | UNDEFINED;
pub const SCALAR: u16 = BYTES | INTEGER | FLOAT | BOOLEAN | TIMESTAMP | REGEX | NULL;
pub const CONTAINER: u16 = OBJECT | ARRAY;

pub use crate::value::{
    Kind,
    kind::{Collection, Field, Index, get, insert, merge, remove},
};

pub trait DefaultValue {
    /// Returns the default [`Value`] for a given [`Kind`].
    ///
    /// If the kind is unknown (or inexact), `null` is returned as the default
    /// value.
    ///
    /// These are (somewhat) arbitrary values that mostly shouldn't be used, but
    /// are particularly useful for the "infallible assignment" expression,
    /// where the `ok` value is set to the default value kind if the expression
    /// results in an error.
    fn default_value(&self) -> Value;
}

impl DefaultValue for Kind {
    fn default_value(&self) -> Value {
        if self.is_bytes() {
            return value!("");
        }

        if self.is_integer() {
            return value!(0_i64);
        }

        if self.is_float() {
            return value!(NotNan::new(0.0).unwrap());
        }

        if self.is_boolean() {
            return value!(false);
        }

        if self.is_timestamp() {
            return Utc
                .timestamp_opt(0, 0)
                .single()
                .expect("invalid timestamp")
                .into();
        }

        if self.is_regex() {
            #[allow(clippy::trivial_regex)]
            return Regex::new("").unwrap().into();
        }

        if self.is_array() {
            return value!([]);
        }

        if self.is_object() {
            return value!({});
        }

        Value::Null
    }
}

#[cfg(test)]
mod tests {
    use std::collections::{BTreeMap, HashMap};

    use super::*;

    #[test]
    fn test_from_value() {
        struct TestCase {
            value: Value,
            want: Kind,
        }

        for (title, TestCase { value, want }) in HashMap::from([
            (
                "bytes",
                TestCase {
                    value: value!("foo"),
                    want: Kind::bytes(),
                },
            ),
            (
                "integer",
                TestCase {
                    value: value!(3_i64),
                    want: Kind::integer(),
                },
            ),
            (
                "float",
                TestCase {
                    value: value!(NotNan::new(3.3).unwrap()),
                    want: Kind::float(),
                },
            ),
            (
                "boolean",
                TestCase {
                    value: value!(true),
                    want: Kind::boolean(),
                },
            ),
            (
                "timestamp",
                TestCase {
                    value: Utc::now().into(),
                    want: Kind::timestamp(),
                },
            ),
            (
                "regex",
                TestCase {
                    value: Regex::new("").unwrap().into(),
                    want: Kind::regex(),
                },
            ),
            (
                "null",
                TestCase {
                    value: value!(null),
                    want: Kind::null(),
                },
            ),
            (
                "object",
                TestCase {
                    value: value!({ "foo": { "bar": 12_i64 }, "baz": true }),
                    want: Kind::object(BTreeMap::from([
                        (
                            "foo".into(),
                            Kind::object(BTreeMap::from([("bar".into(), Kind::integer())])),
                        ),
                        ("baz".into(), Kind::boolean()),
                    ])),
                },
            ),
            (
                "array",
                TestCase {
                    value: value!([12_i64, true, "foo", { "bar": null }]),
                    want: Kind::array(BTreeMap::from([
                        (0.into(), Kind::integer()),
                        (1.into(), Kind::boolean()),
                        (2.into(), Kind::bytes()),
                        (
                            3.into(),
                            Kind::object(BTreeMap::from([("bar".into(), Kind::null())])),
                        ),
                    ])),
                },
            ),
        ]) {
            assert_eq!(Kind::from(value), want, "{title}");
        }
    }
}