reallyme-foundationdb-kit 0.3.2

Production FoundationDB connector and tenant primitives for ReallyMe Platform
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

// SPDX-FileCopyrightText: 2026 ReallyMe LLC
// SPDX-License-Identifier: MIT OR Apache-2.0

//! Tenant metadata keys owned by foundationdb-kit.

use bytes::{Bytes, BytesMut};

use super::codec::KeyEncoder;
use super::error::KeyLabelError;
use super::{namespace::KeyNamespace, prefix::KeyPrefix};

/// Stable metadata namespace within each tenant.
pub const TENANT_METADATA_NAMESPACE: &str = "__meta";
const TENANT_METADATA_VERSION_PREFIX: &str = "v1";
const SCHEMA_VERSION_KEY: &str = "schema_version";
const CREATED_AT_KEY: &str = "created_at";

/// Tenant-scoped metadata key for schema-version.
pub struct TenantMetadataSchemaVersionKey {
    namespace: KeyNamespace,
    prefix: KeyPrefix,
}

/// Tenant-scoped metadata key for metadata creation timestamp.
pub struct TenantMetadataCreatedAtKey {
    namespace: KeyNamespace,
    prefix: KeyPrefix,
}

/// Shared key prefix under `__meta`.
pub struct TenantMetadataVersionPrefix;

impl TenantMetadataVersionPrefix {
    /// Returns a validated `__meta` namespace/prefix pair.
    pub fn components() -> Result<(KeyNamespace, KeyPrefix), KeyLabelError> {
        Ok((
            KeyNamespace::from_static(TENANT_METADATA_NAMESPACE)?,
            KeyPrefix::from_static(TENANT_METADATA_VERSION_PREFIX)?,
        ))
    }
}

impl TenantMetadataSchemaVersionKey {
    /// Builds the `__meta/schema_version` key encoder for a version prefix.
    pub fn new() -> Result<Self, KeyLabelError> {
        let (namespace, prefix) = TenantMetadataVersionPrefix::components()?;
        Ok(Self { namespace, prefix })
    }
}

impl TenantMetadataCreatedAtKey {
    /// Builds the `__meta/created_at` key encoder for a version prefix.
    pub fn new() -> Result<Self, KeyLabelError> {
        let (namespace, prefix) = TenantMetadataVersionPrefix::components()?;
        Ok(Self { namespace, prefix })
    }
}

fn encode_key(namespace: &str, prefix: &str, key: &str) -> Bytes {
    let mut bytes = BytesMut::with_capacity(
        namespace
            .len()
            .checked_add(prefix.len())
            .and_then(|value| value.checked_add(key.len()))
            .and_then(|value| value.checked_add(2))
            .unwrap_or(namespace.len()),
    );

    bytes.extend_from_slice(namespace.as_bytes());
    bytes.extend_from_slice(b"/");
    bytes.extend_from_slice(prefix.as_bytes());
    bytes.extend_from_slice(b"/");
    bytes.extend_from_slice(key.as_bytes());

    bytes.freeze()
}

impl KeyEncoder for TenantMetadataSchemaVersionKey {
    fn encode_key(&self) -> Bytes {
        encode_key(
            self.namespace.as_str(),
            self.prefix.as_str(),
            SCHEMA_VERSION_KEY,
        )
    }
}

impl KeyEncoder for TenantMetadataCreatedAtKey {
    fn encode_key(&self) -> Bytes {
        encode_key(
            self.namespace.as_str(),
            self.prefix.as_str(),
            CREATED_AT_KEY,
        )
    }
}