devela 0.27.0

A development layer of coherence.
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

// devela::data::codec::encode::traits
//
//! Define `Encodable`, `EncodableLen`.
//

use crate::{CodecLen, IoRead, IoResult, IoWrite};

#[doc = crate::_tags!(codec)]
/// A type that can be decoded from an I/O reader.
#[doc = crate::_doc_location!("data/codec")]
///
/// See also [`Encodable`].
pub trait Decodable<R: IoRead>: Sized {
    /// The type produced when decoding.
    type Output;

    /// Decodes `Self` from the given `reader`, returning the decoded value.
    ///
    /// # Errors
    /// Returns an [`IoError`][crate::IoError] if decoding fails.
    fn decode(reader: &mut R) -> IoResult<Self::Output>;
}

#[doc = crate::_tags!(codec)]
/// A type that can be encoded into an I/O writer.
#[doc = crate::_doc_location!("data/codec")]
///
/// See also [`Decodable`].
#[doc = crate::_doc!(vendor: "encode")]
pub trait Encodable<W: IoWrite> {
    /// Encodes `self` into the given `writer`, returning the bytes written.
    ///
    /// # Errors
    /// Returns [`IoError`][crate::IoError] if encoding fails.
    fn encode(&self, writer: &mut W) -> IoResult<usize>;
}

#[doc = crate::_tags!(codec)]
/// A type that can compute the size of its encoded form without actual encoding.
#[doc = crate::_doc_location!("data/codec")]
///
/// This trait is automatically implemented for all types that implement
/// [`Encodable`] with [`CodecLen`].
///
/// See [`CodecLen`] for details on length-based encoding.
#[doc = crate::_doc!(vendor: "encode")]
pub trait EncodableLen: Encodable<CodecLen> {
    /// Computes the size of `self` when encoded.
    ///
    /// This method simulates encoding without writing any data,
    /// allowing for preallocation or buffer sizing.
    fn encoded_size(&self) -> IoResult<usize> {
        let mut encoder = CodecLen::new();
        self.encode(&mut encoder)?;
        Ok(encoder.size())
    }
}
impl<T: Encodable<CodecLen>> EncodableLen for T {}