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
// Copyright 2016 Austin Bonander <austin.bonander@gmail.com> // // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your // option. This file may not be copied, modified, or distributed // except according to those terms. //! Types which can be used to tune the behavior of `BufReader`. //! //! Some simple strategies are provided for your convenience. You may prefer to create your own //! types and implement the traits for them instead. use super::Buffer; use std::fmt; /// The default `ReadStrategy` for this crate. pub type DefaultReadStrategy = IfEmpty; /// The default `MoveStrategy` for this crate. pub type DefaultMoveStrategy = AtEndLessThan1k; /// The default `FlushStrategy` for this crate. pub type DefaultFlushStrategy = WhenFull; /// Trait for types which `BufReader` can consult to determine when it should read more data into the /// buffer. pub trait ReadStrategy: Default + fmt::Debug { /// Returns `true` if the buffer should read more data, `false` otherwise. fn should_read(&self, buffer: &Buffer) -> bool; } /// A `ReadStrategy` which tells the buffer to read more data only when empty. /// /// Default behavior of `std::io::BufReader`. #[derive(Debug, Default)] pub struct IfEmpty; impl ReadStrategy for IfEmpty { #[inline] fn should_read(&self, buffer: &Buffer) -> bool { buffer.buffered() == 0 } } /// A `ReadStrategy` which returns `true` if there is fewer bytes in the buffer /// than the provided value. #[derive(Debug, Default)] pub struct LessThan(pub usize); impl ReadStrategy for LessThan { fn should_read(&self, buffer: &Buffer) -> bool { buffer.buffered() < self.0 } } /// Trait for types which `BufReader` can consult to determine when it should move data /// to the beginning of the buffer. /// /// **Note**: If the buffer is empty, the next read will start at the beginning of the buffer /// regardless of the provided strategy. pub trait MoveStrategy: Default + fmt::Debug { /// Returns `true` if the buffer should move the data down to the beginning, /// `false` otherwise. fn should_move(&self, buffer: &Buffer) -> bool; } /// A `MoveStrategy` which tells the buffer to move data if there is no more room at the end /// of the buffer, *and* if there is less than **1 KiB** of valid data in the buffer. /// /// This avoids excessively large copies while still making room for more reads when appropriate. /// /// Use the `AtEndLessThan` type to set a different threshold. #[derive(Debug, Default)] pub struct AtEndLessThan1k; impl MoveStrategy for AtEndLessThan1k { #[inline] fn should_move(&self, buffer: &Buffer) -> bool { buffer.headroom() == 0 && buffer.buffered() < 1024 } } /// A `MoveStrategy` which triggers if there is no more room at the end of the buffer, /// *and* there are fewer valid bytes in the buffer than the provided value. /// /// `AtEndLessThan(1)` is equivalent to `AtEnd`. /// `AtEndLessThan(1024)` is equivalent to `AtEndLessThan1k`. #[derive(Debug, Default)] pub struct AtEndLessThan(pub usize); impl MoveStrategy for AtEndLessThan { fn should_move(&self, buffer: &Buffer) -> bool { buffer.headroom() == 0 && buffer.buffered() < self.0 } } /// A `MoveStrategy` which always returns `false`. Use this to restore original /// `std::io::BufReader` behavior. #[derive(Debug, Default)] pub struct NeverMove; impl MoveStrategy for NeverMove { #[inline] fn should_move(&self, _: &Buffer) -> bool { false } } /// A trait which tells `BufWriter` when to flush. pub trait FlushStrategy: Default + fmt::Debug { /// Return `true` if the buffer should be flushed before reading into it. /// /// The buffer is provided, as well as `incoming` which is /// the size of the buffer that will be written to the `BufWriter`. fn flush_before(&self, _buf: &Buffer, _incoming: usize) -> bool; /// Return `true` if the buffer should be flushed after reading into it. /// /// `buf` references the updated buffer after the read. /// /// Default impl is a no-op. fn flush_after(&self, _buf: &Buffer) -> bool { false } } /// Flush the buffer if there is no more headroom. Equivalent to the behavior or /// `std::io::BufWriter`. #[derive(Debug, Default)] pub struct WhenFull; impl FlushStrategy for WhenFull { fn flush_before(&self, buf: &Buffer, incoming: usize) -> bool { buf.headroom() < incoming } } /// Flush the buffer if it contains at least the given number of bytes. #[derive(Debug, Default)] pub struct FlushAtLeast(pub usize); impl FlushStrategy for FlushAtLeast { fn flush_before(&self, buf: &Buffer, _: usize) -> bool { buf.buffered() > self.0 } } /// Flush the buffer if it contains at least `8Kb (8192b)`. #[derive(Debug, Default)] pub struct FlushAtLeast8k; impl FlushStrategy for FlushAtLeast8k { fn flush_before(&self, buf: &Buffer, _: usize) -> bool { buf.buffered() > 8192 } } /// Flush the buffer if it contains the given byte. /// /// Only scans the buffer after reading. Searches from the end first. #[derive(Debug, Default)] pub struct FlushOn(pub u8); impl FlushStrategy for FlushOn { /// Same as `WhenFull`. fn flush_before(&self, buf: &Buffer, incoming: usize) -> bool { buf.headroom() < incoming } fn flush_after(&self, buf: &Buffer) -> bool { ::memchr::memrchr(self.0, buf.buf()).is_some() } } /// Flush the buffer if it contains a newline (`\n`). /// /// Equivalent to `FlushOn(b'\n')`. #[derive(Debug, Default)] pub struct FlushOnNewline; impl FlushStrategy for FlushOnNewline { /// Same as `WhenFull`. fn flush_before(&self, buf: &Buffer, incoming: usize) -> bool { buf.headroom() < incoming } fn flush_after(&self, buf: &Buffer) -> bool { ::memchr::memrchr(b'\n', buf.buf()).is_some() } }