envoy-sdk 0.1.0

Rust SDK for WebAssembly-based Envoy extensions
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

// Copyright 2020 Tetrate
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Errors specific to interaction with `Envoy` host ABI.

use std::fmt;

use crate::abi::proxy_wasm::types::Status;

pub use crate::error::{Error, ErrorContext, Result};

/// An error returned from the call to Envoy ABI.
#[derive(Debug)]
pub(crate) struct HostCallError {
    function: Function,
    status: Status,
}

impl HostCallError {
    fn new(function: Function, status: Status) -> Self {
        HostCallError { function, status }
    }
}

impl fmt::Display for HostCallError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "call to the host ABI function \"{}\" has failed with the status code {}",
            self.function, self.status as u32
        )
    }
}

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

/// An error at parsing a return value from a call to Envoy ABI.
#[derive(Debug)]
pub(crate) struct HostResponseError {
    function: Function,
    err: Error,
}

impl HostResponseError {
    fn new(function: Function, err: Error) -> Self {
        HostResponseError { function, err }
    }
}

impl fmt::Display for HostResponseError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "failed to parse value returned by the host ABI function \"{}\": {}",
            self.function, self.err,
        )
    }
}

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

/// Represents a host ABI function.
#[derive(Eq, PartialEq, Clone, Copy, Debug)]
pub(crate) struct Function {
    module: &'static str,
    function: &'static str,
}

impl fmt::Display for Function {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}.{}", self.module, self.function)
    }
}

impl Function {
    fn new(module: &'static str, function: &'static str) -> Self {
        Function { module, function }
    }

    pub fn into_call_error(self, status: Status) -> HostCallError {
        HostCallError::new(self, status)
    }

    pub fn into_parse_error(self, err: Error) -> HostResponseError {
        HostResponseError::new(self, err)
    }
}

pub(crate) fn function(module: &'static str, function: &'static str) -> Function {
    Function::new(module, function)
}