serde_flow 1.1.1

Simplifying migration for serde and zero-copy entities
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

use serde::{de::DeserializeOwned, Deserialize, Serialize};

use crate::encoder::FlowEncoder;
use crate::error::SerdeFlowError;
use std::path::Path;

#[cfg(feature = "zerocopy")]
pub mod zerocopy;

pub type FlowResult<T> = std::result::Result<T, SerdeFlowError>;
pub type AsyncResult<'a, T> = futures_util::future::BoxFuture<'a, FlowResult<T>>;

pub trait File<T: Serialize + DeserializeOwned> {
    fn load_from_path<E: FlowEncoder>(path: &Path) -> FlowResult<T>;
    fn save_to_path<E: FlowEncoder>(&self, path: &Path) -> FlowResult<()>;
}

pub trait FileMigrate<T: Serialize + DeserializeOwned + File<T>> {
    fn load_and_migrate<E: FlowEncoder>(path: &Path) -> FlowResult<T>;
    fn migrate<E: FlowEncoder>(path: &Path) -> FlowResult<()>;
}

pub trait FileAsync<T> {
    fn load_from_path_async<E: FlowEncoder>(path: &Path) -> AsyncResult<T>;
    fn save_to_path_async<'a, E: FlowEncoder>(&'a self, path: &'a Path) -> AsyncResult<()>;
}

pub trait FileMigrateAsync<T: FileAsync<T>> {
    fn load_and_migrate_async<E: FlowEncoder>(path: &Path) -> AsyncResult<T>;
    fn migrate_async<E: FlowEncoder>(path: &Path) -> AsyncResult<()>;
}

pub trait Bytes<T> {
    fn encode<E: FlowEncoder>(&self) -> FlowResult<Vec<u8>>;
    fn decode<E: FlowEncoder>(bytes: &[u8]) -> FlowResult<T>;
}

#[cfg(feature = "serde")]
#[derive(Serialize, Deserialize)]
pub struct FlowId {
    pub flow_id: u16,
}