substrait 0.63.0

Cross-Language Serialization for Relational Algebra
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

// SPDX-License-Identifier: Apache-2.0

//! Parsing of [proto::PlanVersion].

use crate::{parse::proto::Version, proto};
use thiserror::Error;

use super::VersionError;

/// A parsed [proto::PlanVersion].
#[derive(Clone, Debug, PartialEq)]
pub struct PlanVersion {
    /// The version of the plan.
    version: Version,
}

impl PlanVersion {
    /// Returns the version of this plan version.
    ///
    /// See [proto::PlanVersion::version].
    pub fn version(&self) -> &Version {
        &self.version
    }
}

/// Parse errors for [proto::PlanVersion].
#[derive(Debug, Error, PartialEq)]
pub enum PlanVersionError {
    /// Version is missing.
    #[error("version must be specified")]
    Missing,

    /// Version error.
    #[error("version must be valid")]
    Version(#[from] VersionError),
}

impl TryFrom<proto::PlanVersion> for PlanVersion {
    type Error = PlanVersionError;

    fn try_from(value: proto::PlanVersion) -> Result<Self, Self::Error> {
        let proto::PlanVersion { version } = value;

        // The version is required, and must be valid.
        let version = version
            .map(Version::try_from)
            .transpose()?
            .ok_or(PlanVersionError::Missing)?;

        let plan_version = PlanVersion { version };

        Ok(plan_version)
    }
}

impl From<PlanVersion> for proto::PlanVersion {
    fn from(plan_version: PlanVersion) -> Self {
        let PlanVersion { version } = plan_version;

        proto::PlanVersion {
            version: Some(version.into()),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{parse::proto::VersionError, version};

    #[test]
    fn parse() -> Result<(), PlanVersionError> {
        let plan_version = proto::PlanVersion {
            version: Some(version::version()),
        };
        PlanVersion::try_from(plan_version)?;
        Ok(())
    }

    #[test]
    fn missing() {
        let plan_version = proto::PlanVersion::default();
        assert_eq!(
            PlanVersion::try_from(plan_version),
            Err(PlanVersionError::Missing)
        );
    }

    #[test]
    fn version_error() {
        let plan_version = proto::PlanVersion {
            version: Some(proto::Version::default()),
        };
        assert_eq!(
            PlanVersion::try_from(plan_version),
            Err(PlanVersionError::Version(VersionError::Missing))
        );
    }
}