bytesutil/
traits.rs

1// Copyright (c) 2023, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above copyright notice,
11//       this list of conditions and the following disclaimer in the documentation
12//       and/or other materials provided with the distribution.
13//     * Neither the name of BlockProject 3D nor the names of its contributors
14//       may be used to endorse or promote products derived from this software
15//       without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29use std::io::Read;
30use std::io::Result;
31
32/// Allows to read into a buffer as much as possible.
33///
34/// *Allows the use BufReader with BPX.*
35pub trait ReadFill: Read {
36    /// Reads into `buf` as much as possible.
37    ///
38    /// *Returns the number of bytes that could be read.*
39    ///
40    /// # Arguments
41    ///
42    /// * `buf`: the buffer to read into.
43    ///
44    /// returns: Result<usize, Error>
45    ///
46    /// # Errors
47    ///
48    /// Returns an [Error](std::io::Error) when read has failed.
49    fn read_fill(&mut self, buf: &mut [u8]) -> Result<usize> {
50        let mut bytes = 0;
51        let mut len = self.read(buf)?;
52        bytes += len;
53        while len > 0 && buf.len() - len > 0 {
54            len = self.read(&mut buf[len..])?;
55            bytes += len;
56        }
57        Ok(bytes)
58    }
59}
60
61//Unfortunately it's impossible in rust to allow an extension of the Read trait with custom
62// implementations.
63impl<T: Read + ?Sized> ReadFill for T {}
64
65/// Allows reading an entire IO stream into a vec.
66pub trait ReadToVec: Read {
67    /// Loads this stream into memory.
68    ///
69    /// # Errors
70    ///
71    /// An [Error](std::io::Error) is returned if the stream could not be loaded.
72    fn read_to_vec(&mut self) -> Result<Vec<u8>> {
73        let mut data: Vec<u8> = Vec::new();
74        self.read_to_end(&mut data)?;
75        Ok(data)
76    }
77}
bytesutil/traits.rs

bytesutil/
traits.rs
