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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
//! Low level synchronous and asynchronous I/O functions.
//!
//! The functions are used internally to work with generic readers and writers.
//! It is not intended for common users, while we encourage using high level API.

use crate::error::Error;
#[cfg(feature = "async_")]
use futures::io::{AsyncReadExt, AsyncWriteExt};
use std::io::prelude::*;

/// Low level I/O functions with async/await.
#[cfg(feature = "async_")]
pub mod async_ {
    use super::*;

    /// async/await version analogous to blocking [try_read_record](super::blocking::try_read_record).
    pub async fn try_read_record<R>(
        reader: &mut R,
        check_integrity: bool,
    ) -> Result<Option<Vec<u8>>, Error>
    where
        R: AsyncReadExt + Unpin,
    {
        let len = match try_read_len(reader, check_integrity).await? {
            Some(len) => len,
            None => return Ok(None),
        };
        let data = try_read_record_data(reader, len, check_integrity).await?;
        Ok(Some(data))
    }

    /// async/await version analogous to blocking [try_read_len](super::blocking::try_read_len).
    pub async fn try_read_len<R>(
        reader: &mut R,
        check_integrity: bool,
    ) -> Result<Option<usize>, Error>
    where
        R: AsyncReadExt + Unpin,
    {
        let len_buf = {
            let mut len_buf = [0u8; std::mem::size_of::<u64>()];
            match reader.read(&mut len_buf).await {
                Ok(0) => return Ok(None),
                Ok(n) if n == len_buf.len() => (),
                Ok(_) => return Err(Error::UnexpectedEofError),
                Err(error) => return Err(error.into()),
            };
            len_buf
        };
        let len = u64::from_le_bytes(len_buf);

        let expect_cksum = {
            let mut buf = [0; std::mem::size_of::<u32>()];
            reader.read_exact(&mut buf).await?;
            u32::from_le_bytes(buf)
        };

        if check_integrity {
            crate::utils::verify_checksum(&len_buf, expect_cksum)?;
        }

        Ok(Some(len as usize))
    }

    /// async/await version analogous to blocking [try_read_record_data](super::blocking::try_read_record_data).
    pub async fn try_read_record_data<R>(
        reader: &mut R,
        len: usize,
        check_integrity: bool,
    ) -> Result<Vec<u8>, Error>
    where
        R: AsyncReadExt + Unpin,
    {
        let buf = {
            let mut buf = vec![0u8; len];
            reader.read_exact(&mut buf).await?;
            buf
        };
        let expect_cksum = {
            let mut buf = [0u8; std::mem::size_of::<u32>()];
            reader.read_exact(&mut buf).await?;
            u32::from_le_bytes(buf)
        };

        if check_integrity {
            crate::utils::verify_checksum(&buf, expect_cksum)?;
        }
        Ok(buf)
    }

    /// async/await version analogous to blocking [try_write_record](super::blocking::try_write_record).
    pub async fn try_write_record<W>(writer: &mut W, bytes: Vec<u8>) -> Result<(), Error>
    where
        W: AsyncWriteExt + Unpin,
    {
        // write data size
        {
            let len = bytes.len();
            let len_buf = len.to_le_bytes();
            let cksum = crate::utils::checksum(&len_buf);
            let cksum_buf = cksum.to_le_bytes();

            writer.write_all(&len_buf).await?;
            writer.write_all(&cksum_buf).await?;
        }

        // write data
        {
            let cksum = crate::utils::checksum(&bytes);
            let cksum_buf = cksum.to_le_bytes();

            writer.write_all(bytes.as_slice()).await?;
            writer.write_all(&cksum_buf).await?;
        }
        Ok(())
    }
}

/// Low level blocking I/O functions.
pub mod blocking {
    use super::*;

    /// Try to extract raw bytes of a record from a generic reader.
    ///
    /// It reads the record length and data from a generic reader,
    /// and verifies the checksum if requested.
    /// If the end of file is reached, it returns `Ok(None)`.
    pub fn try_read_record<R>(
        reader: &mut R,
        check_integrity: bool,
    ) -> Result<Option<Vec<u8>>, Error>
    where
        R: Read,
    {
        let len = match try_read_len(reader, check_integrity)? {
            Some(len) => len,
            None => return Ok(None),
        };
        let data = try_read_record_data(reader, len, check_integrity)?;
        Ok(Some(data))
    }

    /// Try to read the record length from a generic reader.
    ///
    /// It is internally called by [try_read_record]. It returns `Ok(None)` if reaching the end of file.
    pub fn try_read_len<R>(reader: &mut R, check_integrity: bool) -> Result<Option<usize>, Error>
    where
        R: Read,
    {
        let len_buf = {
            let mut len_buf = [0u8; std::mem::size_of::<u64>()];
            match reader.read(&mut len_buf) {
                Ok(0) => return Ok(None),
                Ok(n) if n == len_buf.len() => (),
                Ok(_) => return Err(Error::UnexpectedEofError),
                Err(error) => return Err(error.into()),
            }
            len_buf
        };
        let len = u64::from_le_bytes(len_buf);
        let expect_cksum = {
            let mut buf = [0; std::mem::size_of::<u32>()];
            reader.read_exact(&mut buf)?;
            u32::from_le_bytes(buf)
        };

        if check_integrity {
            crate::utils::verify_checksum(&len_buf, expect_cksum)?;
        }

        Ok(Some(len as usize))
    }

    /// Read the record raw bytes with given length from a generic reader.
    ///
    /// It is internally called by [try_read_record].
    pub fn try_read_record_data<R>(
        reader: &mut R,
        len: usize,
        check_integrity: bool,
    ) -> Result<Vec<u8>, Error>
    where
        R: Read,
    {
        let buf = {
            let mut buf = vec![0u8; len];
            reader.read_exact(&mut buf)?;
            buf
        };
        let expect_cksum = {
            let mut buf = [0; std::mem::size_of::<u32>()];
            reader.read_exact(&mut buf)?;
            u32::from_le_bytes(buf)
        };

        if check_integrity {
            crate::utils::verify_checksum(&buf, expect_cksum)?;
        }
        Ok(buf)
    }

    /// Write the raw record bytes to a generic writer.
    pub fn try_write_record<W>(writer: &mut W, bytes: Vec<u8>) -> Result<(), Error>
    where
        W: Write,
    {
        // write data size
        {
            let len = bytes.len();
            let len_buf = len.to_le_bytes();
            let cksum = crate::utils::checksum(&len_buf);
            let cksum_buf = cksum.to_le_bytes();

            writer.write_all(&len_buf)?;
            writer.write_all(&cksum_buf)?;
        }

        // write data
        {
            let cksum = crate::utils::checksum(&bytes);
            let cksum_buf = cksum.to_le_bytes();

            writer.write_all(bytes.as_slice())?;
            writer.write_all(&cksum_buf)?;
        }
        Ok(())
    }
}