Add BufReader wrapper with performance enhancements

[csnover]

Do you like fast reads? Well then you’ll like this new thing probably.

[v1gnesh]

Could you add some examples of how to sprinkle this magic on top of a struct.
If there's a huge binary file that has known 'record' sizes, and I can set the size of that buffer to the record size.

[csnover]

Could you add some examples of how to sprinkle this magic on top of a struct. If there's a huge binary file that has known 'record' sizes, and I can set the size of that buffer to the record size.

The API is nearly identical to std::io::BufReader, so you can just follow those examples. However, it would probably be a bad idea to set the buffer size to the size of a single record (unless the records are very large). If you are going to try tuning the buffer size, you’d typically want to do that based on the I/O and memory characteristics of the hardware you are planning to run on, not the content being buffered.

[jam1garner]

Is there a reason our BufReader implementation is not available for no_std users?

[jam1garner]

See #143 for future work

[v1gnesh]

If you are going to try tuning the buffer size, you’d typically want to do that based on the I/O and memory characteristics of the hardware you are planning to run on, not the content being buffered.

Thank you, makes sense. For my platform, that's an exercise on its own!