reliakit-codec 0.2.0

Deterministic canonical binary encoding and decoding traits for reliability-oriented Rust values.
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

//! Encoding traits and sinks.

use crate::CodecError;

/// Destination for canonical encoded bytes.
pub trait EncodeSink {
    /// Writes all bytes to the sink or returns an error.
    fn write_all(&mut self, bytes: &[u8]) -> Result<(), CodecError>;
}

/// Trait for deterministic canonical binary encoding.
pub trait CanonicalEncode {
    /// Encodes `self` into `writer` using the crate's canonical binary format.
    fn encode<W: EncodeSink + ?Sized>(&self, writer: &mut W) -> Result<(), CodecError>;
}

#[cfg(feature = "alloc")]
impl EncodeSink for alloc::vec::Vec<u8> {
    fn write_all(&mut self, bytes: &[u8]) -> Result<(), CodecError> {
        self.extend_from_slice(bytes);
        Ok(())
    }
}

#[cfg(feature = "std")]
impl<T: std::io::Write> EncodeSink for std::io::BufWriter<T> {
    fn write_all(&mut self, bytes: &[u8]) -> Result<(), CodecError> {
        std::io::Write::write_all(self, bytes).map_err(|_| CodecError::write_failed())
    }
}