Skip to main content

reifydb_core/key/
migration.rs

1// SPDX-License-Identifier: AGPL-3.0-or-later
2// Copyright (c) 2025 ReifyDB
3
4use crate::{
5	encoded::key::{EncodedKey, EncodedKeyRange},
6	interface::catalog::id::MigrationId,
7	key::{EncodableKey, KeyKind},
8	util::encoding::keycode::{deserializer::KeyDeserializer, serializer::KeySerializer},
9};
10
11const VERSION: u8 = 1;
12
13#[derive(Debug, Clone, PartialEq)]
14pub struct MigrationKey {
15	pub migration: MigrationId,
16}
17
18impl MigrationKey {
19	pub fn new(migration: MigrationId) -> Self {
20		Self {
21			migration,
22		}
23	}
24
25	pub fn encoded(migration: impl Into<MigrationId>) -> EncodedKey {
26		Self::new(migration.into()).encode()
27	}
28
29	pub fn full_scan() -> EncodedKeyRange {
30		EncodedKeyRange::start_end(Some(Self::start()), Some(Self::end()))
31	}
32
33	fn start() -> EncodedKey {
34		let mut serializer = KeySerializer::with_capacity(2);
35		serializer.extend_u8(VERSION);
36		serializer.extend_u8(Self::KIND as u8);
37		serializer.to_encoded_key()
38	}
39
40	fn end() -> EncodedKey {
41		let mut serializer = KeySerializer::with_capacity(2);
42		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8 - 1);
43		serializer.to_encoded_key()
44	}
45}
46
47impl EncodableKey for MigrationKey {
48	const KIND: KeyKind = KeyKind::Migration;
49
50	fn encode(&self) -> EncodedKey {
51		let mut serializer = KeySerializer::with_capacity(10);
52		serializer.extend_u8(VERSION).extend_u8(Self::KIND as u8).extend_u64(self.migration);
53		serializer.to_encoded_key()
54	}
55
56	fn decode(key: &EncodedKey) -> Option<Self> {
57		let mut de = KeyDeserializer::from_bytes(key.as_slice());
58
59		let version = de.read_u8().ok()?;
60		if version != VERSION {
61			return None;
62		}
63
64		let kind: KeyKind = de.read_u8().ok()?.try_into().ok()?;
65		if kind != Self::KIND {
66			return None;
67		}
68
69		let migration = de.read_u64().ok()?;
70
71		Some(Self {
72			migration: MigrationId(migration),
73		})
74	}
75}