actix-telepathy 0.7.0

Cluster extension for the actix actor framework
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

#[cfg(test)]
mod tests;
use std::fmt;

use serde::{Deserialize, Serialize};

/// Provides template for creating custom serializer
///
/// # Example Used in DefaultSerialization
/// ```
/// use serde::{Deserialize, Serialize};
/// use flexbuffers;
/// use actix_telepathy::{ CustomSerialization, CustomSerializationError };
///
/// pub struct DefaultSerialization {}
///
/// impl CustomSerialization for DefaultSerialization {
///     fn serialize<T>(&self, value: &T) -> Result<Vec<u8>, CustomSerializationError>
///     where
///         T: ?Sized + Serialize,
///     {
///         match flexbuffers::to_vec(value) {
///             Ok(vec) => Ok(vec),
///             Err(_) => Err(CustomSerializationError)
///         }
///     }
///
///     fn deserialize<'a, T>(&self, s: &'a [u8]) -> Result<T, CustomSerializationError>
///     where
///         T: ?Sized + Deserialize<'a>,
///     {
///         match flexbuffers::from_slice(s) {
///             Ok(val) => Ok(val),
///             Err(_) => Err(CustomSerializationError)
///         }
///     }
/// }
/// ```
///
/// # Telling Actix-Telepathy to use Custom Serializer
/// - create a `telepathy.yaml` file in your crates root
/// - add your custom struct's name:
/// ```yaml
/// custom_serializer: "MySerializer"
/// ```
/// - import your custom struct whenever you are using the `RemoteMessage` derive macro.
pub trait CustomSerialization {
    fn serialize<T>(&self, value: &T) -> Result<Vec<u8>, CustomSerializationError>
    where
        T: ?Sized + Serialize;
    fn deserialize<'a, T>(&self, s: &'a [u8]) -> Result<T, CustomSerializationError>
    where
        T: Deserialize<'a>;
}

/// Occurs if either the serialization or the deserialization fails for the `CustomSerialization`
/// trait.
pub struct CustomSerializationError;

impl fmt::Display for CustomSerializationError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "An error occurred during the custom (de)serialization")
    }
}

impl fmt::Debug for CustomSerializationError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{{ file: {}, line: {} }}", file!(), line!())
    }
}

/// The default serialization used for remote messages
///
/// The default de/serializer is the Rust version of Flatbuffers - Flexbuffers.
pub struct DefaultSerialization {}

impl CustomSerialization for DefaultSerialization {
    fn serialize<T>(&self, value: &T) -> Result<Vec<u8>, CustomSerializationError>
    where
        T: ?Sized + Serialize,
    {
        match flexbuffers::to_vec(value) {
            Ok(vec) => Ok(vec),
            Err(_) => Err(CustomSerializationError),
        }
    }

    fn deserialize<'a, T>(&self, s: &'a [u8]) -> Result<T, CustomSerializationError>
    where
        T: Deserialize<'a>,
    {
        match flexbuffers::from_slice(s) {
            Ok(val) => Ok(val),
            Err(_) => Err(CustomSerializationError),
        }
    }
}