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 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
//! Provides `EnsuredBuffer` that impls [`BufRead`](https://doc.rust-lang.org/std/io/trait.BufRead.html). //! //! #![warn(missing_docs)] use std::error; use std::fmt; use std::io::{self, BufRead, Read}; /// Default buffer _capacity_ /// /// Current value is 8 kiB, but may change in the future. /// /// # Examples /// /// ``` /// use std::fs::File; /// use ensured_bufreader::{DEFAULT_BUFFER_SIZE, EnsuredBufReader}; /// /// fn main() -> std::io::Result<()> { /// let f = File::open("README.md")?; /// let r = EnsuredBufReader::new(f); /// /// assert_eq!(r.get_capacity(), DEFAULT_BUFFER_SIZE); /// Ok(()) /// } /// ``` pub const DEFAULT_BUFFER_SIZE: usize = 8 * 1024; /// Default _ensured_ size. /// /// Current value is 128 B, but may change in the future. /// # Examples /// /// ``` /// use std::fs::File; /// use ensured_bufreader::{DEFAULT_ENSURED_BYTES, EnsuredBufReader}; /// /// fn main() -> std::io::Result<()> { /// let f = File::open("README.md")?; /// let r = EnsuredBufReader::new(f); /// /// assert_eq!(r.get_ensured_size(), DEFAULT_ENSURED_BYTES); /// Ok(()) /// } /// ``` pub const DEFAULT_ENSURED_BYTES: usize = 128; /// A [`BufRead`](https://doc.rust-lang.org/std/io/trait.BufRead.html)er that ensures _ensured_ bytes in buffer. /// /// `EnsuredBufReader` keeps _ensured_ bytes in buffer if it can read from underlying reader. /// To fetch bytes into buffer, call `fill_buf()`. pub struct EnsuredBufReader<R, B> where R: Read, B: AsRef<[u8]> + AsMut<[u8]>, { inner: R, buf: B, pos: usize, cap: usize, ensured_size: usize, } impl<R: Read> EnsuredBufReader<R, Vec<u8>> { /// Creates a new `EnsuredBufReader` with a default _capacity_ (`DEFAULT_BUFFER_SIZE`) and a default _ensured_ size (`DEFAULT_ENSURED_BYTES`). /// /// # Examples /// /// ``` /// use std::fs::File; /// use ensured_bufreader::EnsuredBufReader; /// /// fn main() -> std::io::Result<()> { /// let f = File::open("README.md")?; /// let r = EnsuredBufReader::new(f); /// Ok(()) /// } /// ``` pub fn new(inner: R) -> EnsuredBufReader<R, Vec<u8>> { EnsuredBufReader::with_capacity_and_ensured_size( DEFAULT_BUFFER_SIZE, DEFAULT_ENSURED_BYTES, inner, ) } /// Creates a new `EnsuredBufReader` with a specified `capacity` and `ensured_size`. /// /// `capacity` must be larger than or equal to `ensured_size`. /// `ensured_size` must be positive. /// /// # Panics /// /// Panics if `capacity` is smaller than `ensured_size`. /// Panics if `ensured_size` is 0. /// /// # Examples /// /// ``` /// use std::fs::File; /// use ensured_bufreader::EnsuredBufReader; /// /// fn main() -> std::io::Result<()> { /// let f = File::open("README.md")?; /// let r = EnsuredBufReader::with_capacity_and_ensured_size(1024, 32, f); /// Ok(()) /// } /// ``` pub fn with_capacity_and_ensured_size( capacity: usize, ensured_size: usize, inner: R, ) -> EnsuredBufReader<R, Vec<u8>> { assert_ne!(ensured_size, 0, "'ensure' must be positive."); assert!( capacity >= ensured_size, "'capacity' ({}) must be larger than or equal to 'ensured_size' ({}).", capacity, ensured_size ); EnsuredBufReader { inner, buf: vec![0; capacity], pos: 0, cap: 0, ensured_size, } } } impl<R: Read> EnsuredBufReader<R, &mut [u8]> { /// Creates a new `EnsuredBufReader` with given buffer. /// /// Buffer length must be larger than or equal to [`DEFAULT_ENSURED_BYTES`](constant.DEFAULT_ENSURED_BYTES.html). /// /// # Panics /// /// Panics if buffer is smaller than DEFAULT_ENSURED_BYTES. /// /// # Examples /// /// ``` /// use std::fs::File; /// use ensured_bufreader::EnsuredBufReader; /// /// fn main() -> std::io::Result<()> { /// let f = File::open("README.md")?; /// let mut buf = [0u8; 1024]; /// let r = EnsuredBufReader::from_mut_ref(&mut buf, f); /// Ok(()) /// } /// ``` pub fn from_mut_ref(buf: &mut [u8], inner: R) -> EnsuredBufReader<R, &mut [u8]> { assert!( buf.len() >= DEFAULT_ENSURED_BYTES, "buffer size ({}) must be larger than or equal to default ensured size' ({}).", buf.len(), DEFAULT_ENSURED_BYTES ); EnsuredBufReader::from_mut_ref_and_ensured_size(buf, DEFAULT_ENSURED_BYTES, inner) } /// Creates a new `EnsuredBufReader` with given buffer and a specified `ensured_size`. /// /// Buffer length must be larger than or equal to `ensured_size`. /// `ensured_size` must be positive. /// /// # Panics /// /// Panics if buffer is smaller than `ensured_size`. /// Panics if `ensured_size` is 0. /// /// # Examples /// /// ``` /// use std::fs::File; /// use ensured_bufreader::EnsuredBufReader; /// /// fn main() -> std::io::Result<()> { /// let f = File::open("README.md")?; /// let mut buf = [0u8; 1024]; /// let r = EnsuredBufReader::from_mut_ref_and_ensured_size(&mut buf, 32, f); /// Ok(()) /// } /// ``` pub fn from_mut_ref_and_ensured_size( buf: &mut [u8], ensured_size: usize, inner: R, ) -> EnsuredBufReader<R, &mut [u8]> { assert_ne!(ensured_size, 0, "'ensure' must be positive."); assert!( buf.len() >= ensured_size, "buffer size ({}) must be larger than or equal to 'ensured_size' ({}).", buf.len(), ensured_size ); EnsuredBufReader { inner, buf, pos: 0, cap: 0, ensured_size, } } } impl<R: Read, B: AsRef<[u8]> + AsMut<[u8]>> EnsuredBufReader<R, B> { /// Creates a new `EnsuredBufReader` with given buffer. /// /// Buffer length must be larger than or equal to [`DEFAULT_ENSURED_BYTES`](constant.DEFAULT_ENSURED_BYTES.html). /// /// # Panics /// /// Panics if buffer is smaller than DEFAULT_ENSURED_BYTES. pub fn from_buffer(buf: B, inner: R) -> EnsuredBufReader<R, B> { assert!( buf.as_ref().len() >= DEFAULT_ENSURED_BYTES, "buffer size ({}) must be larger than or equal to 'ensured_size' ({}).", buf.as_ref().len(), DEFAULT_ENSURED_BYTES ); EnsuredBufReader::from_buffer_and_ensured_size(buf, DEFAULT_ENSURED_BYTES, inner) } /// Creates a new `EnsuredBufReader` with given buffer and a specified `ensured_size`. /// /// Buffer length must be larger than or equal to `ensured_size`. /// `ensured_size` must be positive. /// /// # Panics /// /// Panics if buffer is smaller than `ensured_size`. /// Panics if `ensured_size` is 0. pub fn from_buffer_and_ensured_size( buf: B, ensured_size: usize, inner: R, ) -> EnsuredBufReader<R, B> { assert_ne!(ensured_size, 0, "'ensure' must be positive."); assert!( buf.as_ref().len() >= ensured_size, "buffer size ({}) must be larger than or equal to 'ensured_size' ({}).", buf.as_ref().len(), ensured_size ); EnsuredBufReader { inner, buf, pos: 0, cap: 0, ensured_size, } } /// Returns a reference to current buffer. /// This method doesn't read bytes from underlying reader. /// /// # Examples /// /// ``` /// use std::fs::File; /// use std::io::{self, BufRead}; /// use ensured_bufreader::EnsuredBufReader; /// /// fn main() -> io::Result<()> { /// let f = File::open("README.md")?; /// let mut r = EnsuredBufReader::new(f); /// /// // Read bytes from file and consume 8 bytes. /// let read_bytes = r.fill_buf()?.to_owned(); /// r.consume(8); /// /// // Get buffer. /// // Current buffer should be 8 bytes shorter than `read_bytes`. /// let buf = r.buffer(); /// assert_eq!(buf, &read_bytes[8..]); /// /// Ok(()) /// } /// ``` pub fn buffer(&self) -> &[u8] { &self.buf.as_ref()[self.pos..self.cap] } /// Try to fill buffer and return reference to buffer. /// The buffer filled at least `expected_size` bytes if `EnsuredBufReader` could read from underlying reader. /// /// # Errors /// /// Returns error that has `.kind() == ErrorKind::InvalidInput` if `expected_size` is larger than _capacity_. /// /// # Examples /// /// The buffer will be filled to `expected_size`. /// /// ``` /// use std::fs::File; /// use std::io::{self, BufRead}; /// use ensured_bufreader::EnsuredBufReader; /// /// fn main() -> io::Result<()> { /// let f = File::open("README.md")?; /// let mut r = EnsuredBufReader::with_capacity_and_ensured_size(1024, 1, f); /// /// // Fill buffer. /// let read_bytes = r.fill_buf_to_expected_size(512)?; /// assert!(read_bytes.len() >= 512); /// /// Ok(()) /// } /// ``` /// /// If `expected_size` is larger than _capacity_, error will be returned. /// /// ``` /// use std::fs::File; /// use std::io::{self, BufRead, ErrorKind}; /// use ensured_bufreader::EnsuredBufReader; /// /// fn main() -> io::Result<()> { /// let f = File::open("README.md")?; /// let mut r = EnsuredBufReader::with_capacity_and_ensured_size(512, 1, f); /// /// let err = r.fill_buf_to_expected_size(513).unwrap_err(); /// assert_eq!(err.kind(), ErrorKind::InvalidInput); /// /// Ok(()) /// } /// ``` pub fn fill_buf_to_expected_size(&mut self, expected_size: usize) -> io::Result<&[u8]> { if self.current_bytes() >= expected_size { return Ok(self.buffer()); } if self.buf.as_mut().len() < expected_size { return Err(io::Error::new( io::ErrorKind::InvalidInput, ExpectedSizeTooLargeError(), )); } if self.buf.as_mut().len() - self.pos < expected_size { self.move_buf_to_head() } while self.current_bytes() < expected_size { let n = self.inner.read(&mut self.buf.as_mut()[self.cap..])?; if n == 0 { // Reach EOF break; } self.cap += n; } Ok(self.buffer()) } /// Get current _capacity_ size. /// /// # Examples /// /// ``` /// use std::fs::File; /// use ensured_bufreader::EnsuredBufReader; /// /// fn main() -> std::io::Result<()> { /// let f = File::open("README.md")?; /// let r = EnsuredBufReader::new(f); /// /// assert_eq!(r.get_capacity(), 8192); /// Ok(()) /// } /// ``` pub fn get_capacity(&self) -> usize { self.buf.as_ref().len() } /// Get current _ensured_ size. /// /// # Examples /// /// ``` /// use std::fs::File; /// use ensured_bufreader::EnsuredBufReader; /// /// fn main() -> std::io::Result<()> { /// let f = File::open("README.md")?; /// let r = EnsuredBufReader::new(f); /// /// assert_eq!(r.get_ensured_size(), 128); /// Ok(()) /// } /// ``` pub fn get_ensured_size(&self) -> usize { self.ensured_size } /// Returns count of bytes in buffer. pub fn current_bytes(&self) -> usize { self.cap - self.pos } fn move_buf_to_head(&mut self) { if self.pos == self.cap { self.pos = 0; self.cap = 0; } else { self.buf.as_mut().copy_within(self.pos..self.cap, 0); self.cap -= self.pos; self.pos = 0; } } } impl<R: Read, B: AsRef<[u8]> + AsMut<[u8]>> Read for EnsuredBufReader<R, B> { fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> { let n = self.fill_buf()?.read(buf)?; self.consume(n); Ok(n) } } impl<R: Read, B: AsRef<[u8]> + AsMut<[u8]>> BufRead for EnsuredBufReader<R, B> { fn fill_buf(&mut self) -> io::Result<&[u8]> { self.fill_buf_to_expected_size(self.ensured_size) } fn consume(&mut self, amt: usize) { assert!( amt <= self.current_bytes(), "the amt must be <= the number of bytes in the buffer returned by fill_buf." ); self.pos += amt; } } impl<R, B> fmt::Debug for EnsuredBufReader<R, B> where R: Read + fmt::Debug, B: AsRef<[u8]> + AsMut<[u8]>, { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fmt.debug_struct("EnsuredBufReader") .field("reader", &self.inner) .field( "buffer", &format_args!("{}/{}", self.cap - self.pos, self.buf.as_ref().len()), ) .finish() } } /// An error type may be returned from [`.fill_buf_to_expected_size()`](struct.EnsuredBufReader.html#method.fill_buf_to_expected_size). #[derive(Debug, Clone, Copy)] pub struct ExpectedSizeTooLargeError(); impl fmt::Display for ExpectedSizeTooLargeError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "internal buffer is too small.") } } impl error::Error for ExpectedSizeTooLargeError {}