encode 1.0.0

A simple framework for encoding binary data.
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

use crate::BaseEncoder;
use crate::ByteEncoder;
use std::io::Write;

/// An encoder that adapts [`std::io::Write`] to the [`BaseEncoder`] and [`ByteEncoder`] traits.
///
/// This encoder allows you to write encoded data directly to any type that implements
/// [`std::io::Write`], such as a file or network stream.
///
/// # Example
///
/// ```
/// use encode::Encodable;
/// use encode::encoders::IoEncoder;
///
/// let mut encoder = IoEncoder(std::io::stdout().lock());
/// (b"hello, world!", 0u8).encode(&mut encoder).unwrap();
/// ```
#[repr(transparent)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default, PartialOrd, Ord)]
pub struct IoEncoder<W>(pub W);

impl<W> core::convert::AsRef<W> for IoEncoder<W> {
    #[inline]
    fn as_ref(&self) -> &W {
        &self.0
    }
}

impl<W> core::convert::AsMut<W> for IoEncoder<W> {
    #[inline]
    fn as_mut(&mut self) -> &mut W {
        &mut self.0
    }
}

impl<W> core::borrow::Borrow<W> for IoEncoder<W> {
    #[inline]
    fn borrow(&self) -> &W {
        &self.0
    }
}

impl<W> core::borrow::BorrowMut<W> for IoEncoder<W> {
    #[inline]
    fn borrow_mut(&mut self) -> &mut W {
        &mut self.0
    }
}

impl<W> core::ops::Deref for IoEncoder<W> {
    type Target = W;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<W> core::ops::DerefMut for IoEncoder<W> {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<W> BaseEncoder for IoEncoder<W>
where
    W: Write,
{
    type Error = std::io::Error;
}

impl<W> ByteEncoder for IoEncoder<W>
where
    W: Write,
{
    #[inline]
    fn put_slice(&mut self, slice: &[u8]) -> Result<(), Self::Error> {
        self.0.write_all(slice)
    }

    #[inline]
    fn put_byte(&mut self, byte: u8) -> Result<(), Self::Error> {
        self.0.write_all(&[byte] as &[u8])
    }
}