substrait-explain 0.7.0

Explain Substrait plans as human-readable text.
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

use prost::{Message, Name};

use crate::extensions::registry::ExtensionError;

/// A wrapper around the protobuf `Any` type. Converts to or from
/// `prost_types::Any` or `pbjson_types::Any`.
#[derive(Debug, Clone, PartialEq)]
pub struct Any {
    pub type_url: String,
    pub value: Vec<u8>,
}

/// A reference to a protobuf `Any` type. Can be created from references to
/// [`prost_types::Any`],
/// [`pbjson_types::Any`], or our own [`Any`] type.
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct AnyRef<'a> {
    pub type_url: &'a str,
    pub value: &'a [u8],
}

impl<'a> AnyRef<'a> {
    /// Create a new [`AnyRef`]
    pub fn new(type_url: &'a str, value: &'a [u8]) -> Self {
        Self { type_url, value }
    }

    /// Decode this [`AnyRef`] as a specific protobuf message type
    pub fn decode<M>(&self) -> Result<M, ExtensionError>
    where
        M: prost::Message + Name + Default,
    {
        if self.type_url != M::type_url() {
            return Err(ExtensionError::TypeUrlMismatch {
                expected: M::type_url(),
                actual: self.type_url.to_string(),
            });
        }

        let message = M::decode(self.value).map_err(ExtensionError::DecodeFailed)?;

        Ok(message)
    }
}

impl<'a> From<&'a Any> for AnyRef<'a> {
    fn from(any: &'a Any) -> Self {
        Self {
            type_url: &any.type_url,
            value: &any.value,
        }
    }
}

impl<'a> From<&'a prost_types::Any> for AnyRef<'a> {
    fn from(any: &'a prost_types::Any) -> Self {
        Self {
            type_url: &any.type_url,
            value: &any.value,
        }
    }
}

#[cfg(feature = "serde")]
impl<'a> From<&'a pbjson_types::Any> for AnyRef<'a> {
    fn from(any: &'a pbjson_types::Any) -> Self {
        Self {
            type_url: &any.type_url,
            value: &any.value,
        }
    }
}

impl Any {
    /// Create a new `Any` for the given type from the given value bytes.
    pub fn new(type_url: String, value: Vec<u8>) -> Self {
        Self { type_url, value }
    }

    /// Convert this [`Any`] to a [`AnyRef`].
    pub fn as_ref(&self) -> AnyRef<'_> {
        AnyRef::from(self)
    }

    /// Decode this [`Any`] as a specific protobuf message type
    pub fn decode<M>(&self) -> Result<M, ExtensionError>
    where
        M: prost::Message + Name + Default,
    {
        self.as_ref().decode()
    }

    /// Encode a protobuf message into an [`Any`].
    pub fn encode<M: Message + Name + Default>(message: &M) -> Result<Self, ExtensionError> {
        let mut buf = Vec::new();
        message
            .encode(&mut buf)
            .map_err(ExtensionError::EncodeFailed)?;

        Ok(Any {
            type_url: M::type_url(),
            value: buf,
        })
    }
}

impl From<prost_types::Any> for Any {
    fn from(any: prost_types::Any) -> Self {
        Self {
            type_url: any.type_url,
            value: any.value.to_vec(),
        }
    }
}

impl From<Any> for prost_types::Any {
    fn from(any: Any) -> Self {
        Self {
            type_url: any.type_url,
            value: any.value,
        }
    }
}

#[cfg(feature = "serde")]
impl From<pbjson_types::Any> for Any {
    fn from(any: pbjson_types::Any) -> Self {
        Self {
            type_url: any.type_url,
            value: any.value.to_vec(),
        }
    }
}

#[cfg(feature = "serde")]
impl From<Any> for pbjson_types::Any {
    fn from(any: Any) -> Self {
        Self {
            type_url: any.type_url,
            value: any.value.into(),
        }
    }
}