kodec 0.1.0

Simple crate defining common interface for encoders and decoders.
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

//! Simple crate defining common interface for encoders and decoders.
//!
//! Also provides JSON and binary (bincode) codec implementations
//! that can be enabled with `json` and/or `binary` features.

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

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

use serde::{Deserialize, Serialize};
use std::io::{Read, Write};

/// Trait for encoders.
pub trait Encode {
    type Error;

    /// Encode message into writer.
    fn encode<W, T>(&self, writer: W, message: &T) -> Result<(), Self::Error>
    where
        W: Write,
        T: Serialize;
}

/// Trait for decoders.
pub trait Decode {
    type Error;

    /// Decode message from reader.
    fn decode<R, T>(&self, data: R) -> Result<T, Self::Error>
    where
        R: Read,
        for<'de> T: Deserialize<'de>;
}

/// Helper trait signaling that both encoding and decoding is implemented.
pub trait Codec: Encode + Decode {}

impl<T> Codec for T where T: Encode + Decode {}