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

use std::fmt;

use crate::compiler::{
    Context, Expression, Span, TypeDef,
    expression::Resolved,
    state::{TypeInfo, TypeState},
};
use crate::diagnostic::{DiagnosticMessage, Label, Note};
use crate::parser::ast::Node;

use super::{Expr, ExpressionError};

#[derive(Debug, Clone, PartialEq)]
pub struct Return {
    span: Span,
    expr: Box<Expr>,
}

impl Return {
    /// # Errors
    ///
    /// * The returned value must not be fallible
    pub fn new(span: Span, expr: Node<Expr>, state: &TypeState) -> Result<Self, Error> {
        let (expr_span, expr) = expr.take();
        let type_def = expr.type_info(state).result;

        if type_def.is_fallible() {
            return Err(Error {
                variant: ErrorVariant::FallibleExpr,
                expr_span,
            });
        }

        Ok(Self {
            span,
            expr: Box::new(expr),
        })
    }
}

impl Expression for Return {
    fn resolve(&self, ctx: &mut Context) -> Resolved {
        Err(ExpressionError::Return {
            span: self.span,
            value: self.expr.resolve(ctx)?,
        })
    }

    fn type_info(&self, state: &TypeState) -> TypeInfo {
        let value = self.expr.type_info(state);
        TypeInfo::new(
            state,
            TypeDef::never().with_returns(value.result.kind().clone()),
        )
    }
}

impl fmt::Display for Return {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "return")
    }
}

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

#[derive(Debug)]
pub struct Error {
    variant: ErrorVariant,
    expr_span: Span,
}

#[derive(thiserror::Error, Debug)]
pub(crate) enum ErrorVariant {
    #[error("unhandled fallible expression")]
    FallibleExpr,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:#}", self.variant)
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        Some(&self.variant)
    }
}

impl DiagnosticMessage for Error {
    fn code(&self) -> usize {
        use ErrorVariant::FallibleExpr;

        match self.variant {
            FallibleExpr => 631,
        }
    }

    fn labels(&self) -> Vec<Label> {
        match &self.variant {
            ErrorVariant::FallibleExpr => vec![
                Label::primary(
                    "return only accepts an infallible expression argument",
                    self.expr_span,
                ),
                Label::context(
                    "handle errors before using the expression as a return value",
                    self.expr_span,
                ),
            ],
        }
    }

    fn notes(&self) -> Vec<Note> {
        match self.variant {
            ErrorVariant::FallibleExpr => vec![Note::SeeErrorDocs],
        }
    }
}