Skip to main content

reifydb_core/key/
kind.rs

1// SPDX-License-Identifier: AGPL-3.0-or-later
2// Copyright (c) 2025 ReifyDB
3
4use reifydb_type::error::Error;
5use serde::{Deserialize, Serialize, de};
6
7#[repr(u8)]
8#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
9#[serde(try_from = "u8", into = "u8")]
10pub enum KeyKind {
11	Namespace = 0x01,
12	Table = 0x02,
13	Row = 0x03,
14	NamespaceTable = 0x04,
15	SystemSequence = 0x05,
16	Columns = 0x06,
17	Column = 0x07,
18	RowSequence = 0x08,
19	ColumnProperty = 0x09,
20	SystemVersion = 0x0A,
21	TransactionVersion = 0x0B,
22	Index = 0x0C,
23	IndexEntry = 0x0D,
24	ColumnSequence = 0x0E,
25	CdcConsumer = 0x0F,
26	View = 0x10,
27	NamespaceView = 0x11,
28	PrimaryKey = 0x12,
29	FlowNodeState = 0x13,
30	RingBuffer = 0x14,
31	NamespaceRingBuffer = 0x15,
32	RingBufferMetadata = 0x16,
33	PrimitiveRetentionPolicy = 0x17,
34	OperatorRetentionPolicy = 0x18,
35	Flow = 0x19,
36	NamespaceFlow = 0x1A,
37	FlowNode = 0x1B,
38	FlowNodeByFlow = 0x1C,
39	FlowEdge = 0x1D,
40	FlowEdgeByFlow = 0x1E,
41	FlowNodeInternalState = 0x1F,
42	Dictionary = 0x20,
43	DictionaryEntry = 0x21,
44	DictionaryEntryIndex = 0x22,
45	NamespaceDictionary = 0x23,
46	DictionarySequence = 0x24,
47	Metric = 0x25,
48	FlowVersion = 0x26,
49	Subscription = 0x27,
50	SubscriptionRow = 0x28,
51	SubscriptionColumn = 0x29,
52	Schema = 0x2A,
53	SchemaField = 0x2B,
54	SumType = 0x2C,
55	NamespaceSumType = 0x2D,
56	Handler = 0x2E,
57	NamespaceHandler = 0x2F,
58	VariantHandler = 0x30,
59	Series = 0x31,
60	NamespaceSeries = 0x32,
61	SeriesMetadata = 0x33,
62	User = 0x34,
63	Role = 0x35,
64	UserRole = 0x36,
65	Policy = 0x37,
66	PolicyOp = 0x38,
67	Migration = 0x39,
68	MigrationEvent = 0x3A,
69	UserAuthentication = 0x3B,
70	Config = 0x3C,
71}
72
73impl From<KeyKind> for u8 {
74	fn from(kind: KeyKind) -> Self {
75		kind as u8
76	}
77}
78impl TryFrom<u8> for KeyKind {
79	type Error = Error;
80
81	fn try_from(value: u8) -> Result<Self, Self::Error> {
82		match value {
83			0x01 => Ok(Self::Namespace),
84			0x02 => Ok(Self::Table),
85			0x03 => Ok(Self::Row),
86			0x04 => Ok(Self::NamespaceTable),
87			0x05 => Ok(Self::SystemSequence),
88			0x06 => Ok(Self::Columns),
89			0x07 => Ok(Self::Column),
90			0x08 => Ok(Self::RowSequence),
91			0x09 => Ok(Self::ColumnProperty),
92			0x0A => Ok(Self::SystemVersion),
93			0x0B => Ok(Self::TransactionVersion),
94			0x0C => Ok(Self::Index),
95			0x0D => Ok(Self::IndexEntry),
96			0x0E => Ok(Self::ColumnSequence),
97			0x0F => Ok(Self::CdcConsumer),
98			0x10 => Ok(Self::View),
99			0x11 => Ok(Self::NamespaceView),
100			0x12 => Ok(Self::PrimaryKey),
101			0x13 => Ok(Self::FlowNodeState),
102			0x14 => Ok(Self::RingBuffer),
103			0x15 => Ok(Self::NamespaceRingBuffer),
104			0x16 => Ok(Self::RingBufferMetadata),
105			0x17 => Ok(Self::PrimitiveRetentionPolicy),
106			0x18 => Ok(Self::OperatorRetentionPolicy),
107			0x19 => Ok(Self::Flow),
108			0x1A => Ok(Self::NamespaceFlow),
109			0x1B => Ok(Self::FlowNode),
110			0x1C => Ok(Self::FlowNodeByFlow),
111			0x1D => Ok(Self::FlowEdge),
112			0x1E => Ok(Self::FlowEdgeByFlow),
113			0x1F => Ok(Self::FlowNodeInternalState),
114			0x20 => Ok(Self::Dictionary),
115			0x21 => Ok(Self::DictionaryEntry),
116			0x22 => Ok(Self::DictionaryEntryIndex),
117			0x23 => Ok(Self::NamespaceDictionary),
118			0x24 => Ok(Self::DictionarySequence),
119			0x25 => Ok(Self::Metric),
120			0x26 => Ok(Self::FlowVersion),
121			0x27 => Ok(Self::Subscription),
122			0x28 => Ok(Self::SubscriptionRow),
123			0x29 => Ok(Self::SubscriptionColumn),
124			0x2A => Ok(Self::Schema),
125			0x2B => Ok(Self::SchemaField),
126			0x2C => Ok(Self::SumType),
127			0x2D => Ok(Self::NamespaceSumType),
128			0x2E => Ok(Self::Handler),
129			0x2F => Ok(Self::NamespaceHandler),
130			0x30 => Ok(Self::VariantHandler),
131			0x31 => Ok(Self::Series),
132			0x32 => Ok(Self::NamespaceSeries),
133			0x33 => Ok(Self::SeriesMetadata),
134			0x34 => Ok(Self::User),
135			0x35 => Ok(Self::Role),
136			0x36 => Ok(Self::UserRole),
137			0x37 => Ok(Self::Policy),
138			0x38 => Ok(Self::PolicyOp),
139			0x39 => Ok(Self::Migration),
140			0x3A => Ok(Self::MigrationEvent),
141			0x3B => Ok(Self::UserAuthentication),
142			0x3C => Ok(Self::Config),
143			_ => Err(de::Error::custom(format!("Invalid KeyKind value: {value:#04x}"))),
144		}
145	}
146}