miden-node-persistence 0.17.0

Protobuf persistence codecs for Miden node
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

//! Protobuf codecs for structured database values and binary files.

mod collections;
mod error;
pub mod generated;
mod protocol;

pub use error::PersistenceError;
pub use miden_protobuf;
pub use prost;

/// Defines the stored representation and domain validation for one type.
pub trait ProtobufValue: Sized {
    /// The protobuf message stored for this type.
    type Message: prost::Message + Default;
    /// Builds the stored protobuf message.
    fn to_proto(&self) -> Self::Message;
    /// Builds the domain value and checks its construction constraints.
    fn from_proto(message: Self::Message) -> Result<Self, PersistenceError>;
}

/// Encodes a structured value as its protobuf message.
pub fn encode<T: ProtobufValue>(value: &T) -> Vec<u8> {
    prost::Message::encode_to_vec(&value.to_proto())
}

/// Decodes a stored message and applies its domain construction checks.
pub fn decode<T: ProtobufValue>(bytes: &[u8]) -> Result<T, PersistenceError> {
    let message = <T::Message as prost::Message>::decode(bytes)?;
    T::from_proto(message)
}

#[cfg(test)]
mod tests;