pdk-data-storage-lib 1.9.1

PDK Data Storage Library
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

// Copyright (c) 2026, Salesforce, Inc.,
// All rights reserved.
// For full license text, see the LICENSE.txt file

use crate::DataStorageError;
use serde::{Deserialize, Serialize};
use std::marker::PhantomData;

/// This enum is used to wrap the errors returned by the format implementations. In case no format
/// is configured, the default Serialization(fixint) error will be returned or
/// the new Format(Box<dyn Error>) will be used.
#[derive(Debug)]
pub(crate) enum FormatWrapper<F: Format> {
    Default(DefaultFormat, PhantomData<F>),
    #[cfg(feature = "experimental_datastorage_formats")]
    Custom(F),
}

impl<F: Format + Clone> Clone for FormatWrapper<F> {
    fn clone(&self) -> Self {
        match self {
            FormatWrapper::Default(format, _) => {
                FormatWrapper::Default(format.clone(), PhantomData)
            }
            #[cfg(feature = "experimental_datastorage_formats")]
            FormatWrapper::Custom(format) => FormatWrapper::Custom(format.clone()),
        }
    }
}

impl<F: Format> FormatWrapper<F> {
    pub fn serialize<T: Serialize>(&self, item: &T) -> Result<Vec<u8>, DataStorageError> {
        match self {
            FormatWrapper::Default(format, _) => Ok(format.serialize(item)?),
            #[cfg(feature = "experimental_datastorage_formats")]
            FormatWrapper::Custom(format) => format
                .serialize(item)
                .map_err(|e| DataStorageError::Format(e.into())),
        }
    }

    pub fn deserialize<'a, T>(&self, bytes: &'a [u8]) -> Result<T, DataStorageError>
    where
        T: Deserialize<'a>,
    {
        match self {
            FormatWrapper::Default(format, _) => Ok(format.deserialize(bytes)?),
            #[cfg(feature = "experimental_datastorage_formats")]
            FormatWrapper::Custom(format) => format
                .deserialize(bytes)
                .map_err(|e| DataStorageError::Format(e.into())),
        }
    }
}

pub trait Format {
    type SerializeError: Into<Box<dyn std::error::Error>>;
    type DeserializeError: Into<Box<dyn std::error::Error>>;

    fn serialize<T: Serialize>(&self, item: &T) -> Result<Vec<u8>, Self::SerializeError>;

    fn deserialize<'a, T>(&self, bytes: &'a [u8]) -> Result<T, Self::DeserializeError>
    where
        T: Deserialize<'a>;
}

pub(super) type DefaultFormat = Fixint;

/// The default wire format: fixed-width little-endian binary, byte-compatible
/// with the legacy serialization previously used by this library.
#[derive(Debug, Default, Clone)]
pub struct Fixint {
    // Reserved for internal status
    _priv: (),
}

impl Format for Fixint {
    type SerializeError = serde_fixint::Error;
    type DeserializeError = serde_fixint::Error;

    fn serialize<T: serde::Serialize>(&self, item: &T) -> Result<Vec<u8>, Self::SerializeError> {
        serde_fixint::to_vec(item)
    }

    fn deserialize<'a, T>(&self, bytes: &'a [u8]) -> Result<T, Self::SerializeError>
    where
        T: Deserialize<'a>,
    {
        serde_fixint::from_slice(bytes)
    }
}

#[cfg(feature = "experimental_datastorage_formats")]
#[derive(Debug, Default, Clone)]
pub struct MessagePack {
    // Reserved for internal status
    _priv: (),
}

#[cfg(feature = "experimental_datastorage_formats")]
impl Format for MessagePack {
    type SerializeError = rmp_serde::encode::Error;
    type DeserializeError = rmp_serde::decode::Error;

    fn serialize<T: serde::Serialize>(&self, item: &T) -> Result<Vec<u8>, Self::SerializeError> {
        rmp_serde::to_vec(item)
    }

    fn deserialize<'a, T>(&self, bytes: &'a [u8]) -> Result<T, Self::DeserializeError>
    where
        T: Deserialize<'a>,
    {
        rmp_serde::from_slice(bytes)
    }
}