radixdb-catalog 1.1.0

Generational logical catalog owner for RadixDB
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

use crate::payload::common::{validate_flags, validate_version};
use crate::{CatalogDataType, CatalogError, CatalogResult, ObjectId};

pub const MAX_OPERATOR_LOCAL_ID_BYTES: usize = 255;
pub const MAX_OPERATOR_SYMBOL_BYTES: usize = 3;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct OperatorPayload {
    extension_binding_id: ObjectId,
    local_id: String,
    semantic_revision: u32,
    symbol: String,
    left_argument: Option<CatalogDataType>,
    right_argument: Option<CatalogDataType>,
    result_type: CatalogDataType,
    backing_function_id: ObjectId,
}

impl OperatorPayload {
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        extension_binding_id: ObjectId,
        local_id: impl Into<String>,
        semantic_revision: u32,
        symbol: impl Into<String>,
        left_argument: Option<CatalogDataType>,
        right_argument: Option<CatalogDataType>,
        result_type: CatalogDataType,
        backing_function_id: ObjectId,
    ) -> CatalogResult<Self> {
        Self::from_fields(
            super::PAYLOAD_VERSION,
            0,
            extension_binding_id,
            local_id.into(),
            semantic_revision,
            symbol.into(),
            left_argument,
            right_argument,
            result_type,
            backing_function_id,
        )
    }

    #[allow(clippy::too_many_arguments)]
    pub fn from_fields(
        version: u16,
        flags: u64,
        extension_binding_id: ObjectId,
        local_id: String,
        semantic_revision: u32,
        symbol: String,
        left_argument: Option<CatalogDataType>,
        right_argument: Option<CatalogDataType>,
        result_type: CatalogDataType,
        backing_function_id: ObjectId,
    ) -> CatalogResult<Self> {
        validate_version("operator", version)?;
        validate_flags("operator", flags)?;
        if local_id.is_empty()
            || local_id.len() > MAX_OPERATOR_LOCAL_ID_BYTES
            || local_id.contains('\0')
        {
            return Err(CatalogError::InvalidOperatorPayload {
                detail: "local id must be 1..=255 UTF-8 bytes without NUL",
            });
        }
        if semantic_revision == 0 {
            return Err(CatalogError::InvalidOperatorPayload {
                detail: "semantic revision must be at least one",
            });
        }
        if !matches!(
            symbol.as_str(),
            "=" | "<>"
                | "!="
                | "<"
                | "<="
                | ">"
                | ">="
                | "+"
                | "-"
                | "*"
                | "/"
                | "%"
                | "||"
                | "&"
                | "|"
                | "^"
                | "~"
                | "<<"
                | ">>"
                | "<=>"
                | "&&"
                | "@>"
                | "<@"
        ) {
            return Err(CatalogError::InvalidOperatorPayload {
                detail: "operator symbol is outside the closed v1 alphabet",
            });
        }
        if right_argument.is_none() || (left_argument.is_none() && right_argument.is_none()) {
            return Err(CatalogError::InvalidOperatorPayload {
                detail:
                    "operator must be unary prefix or binary; postfix operators are not admitted",
            });
        }
        Ok(Self {
            extension_binding_id,
            local_id,
            semantic_revision,
            symbol,
            left_argument,
            right_argument,
            result_type,
            backing_function_id,
        })
    }

    pub const fn flags(&self) -> u64 {
        0
    }
    pub const fn extension_binding_id(&self) -> ObjectId {
        self.extension_binding_id
    }
    pub fn local_id(&self) -> &str {
        &self.local_id
    }
    pub const fn semantic_revision(&self) -> u32 {
        self.semantic_revision
    }
    pub fn symbol(&self) -> &str {
        &self.symbol
    }
    pub const fn left_argument(&self) -> Option<CatalogDataType> {
        self.left_argument
    }
    pub const fn right_argument(&self) -> Option<CatalogDataType> {
        self.right_argument
    }
    pub const fn result_type(&self) -> CatalogDataType {
        self.result_type
    }
    pub const fn backing_function_id(&self) -> ObjectId {
        self.backing_function_id
    }
}