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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use std::fmt;

use crate::diagnostic::{DiagnosticMessage, Label, Note, Urls};

use crate::compiler::expression::Block;
use crate::compiler::{
    Context, Expression, Span,
    expression::{Expr, Resolved},
    parser::Node,
    state::{TypeInfo, TypeState},
    value::Kind,
};

pub(crate) type Result = std::result::Result<Predicate, Error>;

#[derive(Clone, PartialEq)]
pub struct Predicate {
    inner: Block,
}

impl Predicate {
    pub(crate) fn new(
        node: Node<Vec<Expr>>,
        state: &TypeState,
        fallible_predicate: Option<&dyn DiagnosticMessage>,
    ) -> Result {
        let (span, exprs) = node.take();

        if let Some(error) = fallible_predicate {
            return Err(Error::Fallible {
                code: error.code(),
                labels: error.labels(),
                notes: error.notes(),
            });
        }

        let block = Block::new_inline(exprs);
        let type_def = block.type_info(state).result;
        if !type_def.is_boolean() {
            return Err(Error::NonBoolean {
                kind: type_def.into(),
                span,
            });
        }

        Ok(Self { inner: block })
    }

    #[must_use]
    pub fn new_unchecked(inner: Vec<Expr>) -> Self {
        Self {
            inner: Block::new_inline(inner),
        }
    }
}

impl Expression for Predicate {
    fn resolve(&self, ctx: &mut Context) -> Resolved {
        self.inner.resolve(ctx)
    }

    fn type_info(&self, state: &TypeState) -> TypeInfo {
        self.inner.type_info(state)
    }
}

impl fmt::Display for Predicate {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if self.inner.exprs().len() > 1 {
            f.write_str("(")?;
        }

        let mut iter = self.inner.exprs().iter().peekable();
        while let Some(expr) = iter.next() {
            expr.fmt(f)?;

            if iter.peek().is_some() {
                f.write_str("; ")?;
            }
        }

        if self.inner.exprs().len() > 1 {
            f.write_str("(")?;
        }

        Ok(())
    }
}

impl fmt::Debug for Predicate {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("Predicate(")?;

        let mut iter = self.inner.exprs().iter().peekable();
        while let Some(expr) = iter.next() {
            expr.fmt(f)?;

            if iter.peek().is_some() {
                f.write_str("; ")?;
            }
        }

        f.write_str(")")
    }
}

// -----------------------------------------------------------------------------

#[derive(thiserror::Error, Debug)]
pub(crate) enum Error {
    #[error("non-boolean predicate")]
    NonBoolean { kind: Kind, span: Span },

    #[error("fallible predicate")]
    Fallible {
        code: usize,
        labels: Vec<Label>,
        notes: Vec<Note>,
    },
}

impl DiagnosticMessage for Error {
    fn code(&self) -> usize {
        use Error::{Fallible, NonBoolean};

        match self {
            NonBoolean { .. } => 102,
            Fallible { code, .. } => *code,
        }
    }

    fn labels(&self) -> Vec<Label> {
        use Error::{Fallible, NonBoolean};

        match self {
            NonBoolean { kind, span } => vec![
                Label::primary("this predicate must resolve to a boolean", span),
                Label::context(format!("instead it resolves to {kind}"), span),
            ],
            Fallible { labels, .. } => labels.clone(),
        }
    }

    fn notes(&self) -> Vec<Note> {
        use Error::{Fallible, NonBoolean};

        match self {
            NonBoolean { .. } => vec![
                Note::CoerceValue,
                Note::SeeDocs(
                    "if expressions".to_owned(),
                    Urls::expression_docs_url("#if"),
                ),
            ],
            Fallible { notes, .. } => notes.clone(),
        }
    }
}