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
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! Encoder and decoder for padding bytes.
use {ByteCount, Decode, Encode, Eos, ErrorKind, Result};

/// Decoder for reading padding bytes from input streams.
///
/// `PaddingDecoder` discards any bytes in a stream until it reaches EOS.
#[derive(Debug, Default)]
pub struct PaddingDecoder {
    expected_byte: Option<u8>,
    eos: bool,
}
impl PaddingDecoder {
    /// Makes a new `PaddingDecoder` instance.
    pub fn new(expected_byte: Option<u8>) -> Self {
        PaddingDecoder {
            expected_byte,
            eos: false,
        }
    }

    /// Returns the expected byte used for padding.
    ///
    /// `None` means that this decoder accepts any bytes.
    pub fn expected_byte(&self) -> Option<u8> {
        self.expected_byte
    }

    /// Sets the expected byte used for padding.
    pub fn set_expected_byte(&mut self, b: Option<u8>) {
        self.expected_byte = b;
    }
}
impl Decode for PaddingDecoder {
    type Item = ();

    fn decode(&mut self, buf: &[u8], eos: Eos) -> Result<usize> {
        if self.eos {
            Ok(0)
        } else if let Some(expected) = self.expected_byte {
            for &padding_byte in buf {
                track_assert_eq!(padding_byte, expected, ErrorKind::InvalidInput);
            }
            self.eos = eos.is_reached();
            Ok(buf.len())
        } else {
            self.eos = eos.is_reached();
            Ok(buf.len())
        }
    }

    fn finish_decoding(&mut self) -> Result<Self::Item> {
        track_assert!(self.eos, ErrorKind::IncompleteDecoding);
        self.eos = false;
        Ok(())
    }

    fn is_idle(&self) -> bool {
        self.eos
    }

    fn requiring_bytes(&self) -> ByteCount {
        if self.eos {
            ByteCount::Finite(0)
        } else {
            ByteCount::Infinite
        }
    }
}

/// Encoder for writing padding bytes to output streams.
///
/// After `start_encoding` is called, it will write the specified padding byte repeatedly
/// until it the output stream reaches EOS.
#[derive(Debug, Default)]
pub struct PaddingEncoder {
    padding_byte: Option<u8>,
}
impl PaddingEncoder {
    /// Makes a new `PaddingEncoder` instance.
    pub fn new() -> Self {
        Self::default()
    }
}
impl Encode for PaddingEncoder {
    type Item = u8;

    fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize> {
        if let Some(padding_byte) = self.padding_byte {
            for b in &mut buf[..] {
                *b = padding_byte
            }
            if eos.is_reached() {
                self.padding_byte = None;
            }
            Ok(buf.len())
        } else {
            Ok(0)
        }
    }

    fn start_encoding(&mut self, item: Self::Item) -> Result<()> {
        track_assert!(self.is_idle(), ErrorKind::EncoderFull);
        self.padding_byte = Some(item);
        Ok(())
    }

    fn requiring_bytes(&self) -> ByteCount {
        if self.is_idle() {
            ByteCount::Finite(0)
        } else {
            ByteCount::Infinite
        }
    }

    fn is_idle(&self) -> bool {
        self.padding_byte.is_none()
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use io::IoDecodeExt;
    use {Encode, EncodeExt, Eos};

    #[test]
    fn padding_encoder_works() {
        let mut encoder = track_try_unwrap!(PaddingEncoder::with_item(3));
        let mut buf = [0; 8];
        track_try_unwrap!(encoder.encode(&mut buf[..], Eos::new(true)));
        assert_eq!(buf, [3; 8]);
        assert!(encoder.is_idle());
    }

    #[test]
    fn padding_decoder_works() {
        let mut decoder = PaddingDecoder::new(None);
        assert!(decoder.decode_exact(&[0; 8][..]).is_ok());

        let mut decoder = PaddingDecoder::new(Some(1));
        assert!(decoder.decode_exact(&[1; 8][..]).is_ok());
        assert!(decoder.decode_exact(&[0; 8][..]).is_err());
    }
}