Add notes on Reader methods

Author: Brian Obot

file.html

@@ -0,0 +1 @@
+lorem40

hello.txt

@@ -1 +1,9 @@
-hello world
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam commodo sit amet elit ut consequat. Fusce posuere mollis libero vitae feugiat. Vestibulum nec nisl feugiat, fringilla odio sit amet, luctus mauris. Ut scelerisque dui a purus molestie, at sodales metus posuere. Sed odio velit, malesuada ac turpis vitae, bibendum facilisis lorem. Cras in tellus viverra, suscipit ante vel, eleifend enim. Sed mauris sem, facilisis at tristique eu, commodo a urna. Cras mauris justo, suscipit sed sapien sed, tristique aliquam nunc.
+
+Praesent augue neque, volutpat in accumsan ac, semper ac leo. Suspendisse fringilla condimentum aliquam. Etiam luctus bibendum ipsum, eu molestie leo euismod id. Pellentesque eu risus quis erat aliquam fermentum. Nulla ac varius nunc, nec venenatis arcu. Curabitur at sagittis quam. Praesent ut tristique nunc. Integer erat sapien, tempus sed bibendum et, commodo eget velit. In vitae libero lacinia, lobortis neque a, fringilla arcu. Sed tincidunt vestibulum viverra.
+
+Sed velit libero, pharetra sit amet ex id, viverra egestas orci. Suspendisse orci dui, cursus vitae dui id, imperdiet faucibus nunc. Duis efficitur sed dui non dapibus. Duis non erat porttitor, pretium magna non, accumsan lectus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Mauris dolor ipsum, fringilla ut congue ac, blandit ut neque. Nullam suscipit est ut libero pulvinar lacinia. Morbi id ultricies libero, ut rhoncus purus. Aenean vehicula porttitor mattis. Curabitur volutpat suscipit augue sed euismod. Maecenas luctus tellus sit amet quam semper vestibulum. Vivamus feugiat, orci in fermentum lobortis, enim velit fringilla dui, ultrices semper magna mauris id dui. Aliquam consectetur ut lectus ac suscipit. Nullam gravida nibh id vestibulum feugiat.
+
+Duis interdum nibh nulla, nec commodo libero finibus quis. Mauris a eleifend dolor, quis ultrices orci. Nunc facilisis, massa nec malesuada feugiat, neque velit aliquam dolor, rhoncus dignissim mi eros pharetra libero. Donec quis dui vehicula leo pulvinar interdum. Integer pellentesque eu dolor eget pretium. Nunc tincidunt scelerisque augue, a elementum eros pellentesque in. Ut vitae est felis. Curabitur scelerisque semper lectus nec aliquet. Phasellus sed odio eget turpis commodo tempor ac eget dui. Ut a tortor libero. Maecenas tortor dui, ultricies sit amet arcu nec, iaculis suscipit risus.
+
+Nulla elementum quis felis a rhoncus. Nulla lorem mauris, tempor at orci a, volutpat consectetur libero. In hac habitasse platea dictumst. Pellentesque finibus leo in mauris faucibus, eget convallis nulla euismod. Aenean sed rutrum sapien. Integer ultricies dapibus mollis. Nunc nec magna augue. Ut eu suscipit turpis, id tristique ligula. Mauris ut diam at neque tincidunt imperdiet nec et justo. Etiam eget elit ac augue dignissim accumsan. Duis facilisis vestibulum dolor, ut venenatis enim tincidunt vitae. Pellentesque a lacus eget justo porttitor mollis. Donec et tellus blandit, tincidunt nulla ac, consequat lorem. Curabitur placerat dictum elit at pretium.

sample_file.txt

@@ -1 +1,9 @@
-lorem
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam commodo sit amet elit ut consequat. Fusce posuere mollis libero vitae feugiat. Vestibulum nec nisl feugiat, fringilla odio sit amet, luctus mauris. Ut scelerisque dui a purus molestie, at sodales metus posuere. Sed odio velit, malesuada ac turpis vitae, bibendum facilisis lorem. Cras in tellus viverra, suscipit ante vel, eleifend enim. Sed mauris sem, facilisis at tristique eu, commodo a urna. Cras mauris justo, suscipit sed sapien sed, tristique aliquam nunc.
+
+Praesent augue neque, volutpat in accumsan ac, semper ac leo. Suspendisse fringilla condimentum aliquam. Etiam luctus bibendum ipsum, eu molestie leo euismod id. Pellentesque eu risus quis erat aliquam fermentum. Nulla ac varius nunc, nec venenatis arcu. Curabitur at sagittis quam. Praesent ut tristique nunc. Integer erat sapien, tempus sed bibendum et, commodo eget velit. In vitae libero lacinia, lobortis neque a, fringilla arcu. Sed tincidunt vestibulum viverra.
+
+Sed velit libero, pharetra sit amet ex id, viverra egestas orci. Suspendisse orci dui, cursus vitae dui id, imperdiet faucibus nunc. Duis efficitur sed dui non dapibus. Duis non erat porttitor, pretium magna non, accumsan lectus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Mauris dolor ipsum, fringilla ut congue ac, blandit ut neque. Nullam suscipit est ut libero pulvinar lacinia. Morbi id ultricies libero, ut rhoncus purus. Aenean vehicula porttitor mattis. Curabitur volutpat suscipit augue sed euismod. Maecenas luctus tellus sit amet quam semper vestibulum. Vivamus feugiat, orci in fermentum lobortis, enim velit fringilla dui, ultrices semper magna mauris id dui. Aliquam consectetur ut lectus ac suscipit. Nullam gravida nibh id vestibulum feugiat.
+
+Duis interdum nibh nulla, nec commodo libero finibus quis. Mauris a eleifend dolor, quis ultrices orci. Nunc facilisis, massa nec malesuada feugiat, neque velit aliquam dolor, rhoncus dignissim mi eros pharetra libero. Donec quis dui vehicula leo pulvinar interdum. Integer pellentesque eu dolor eget pretium. Nunc tincidunt scelerisque augue, a elementum eros pellentesque in. Ut vitae est felis. Curabitur scelerisque semper lectus nec aliquet. Phasellus sed odio eget turpis commodo tempor ac eget dui. Ut a tortor libero. Maecenas tortor dui, ultricies sit amet arcu nec, iaculis suscipit risus.
+
+Nulla elementum quis felis a rhoncus. Nulla lorem mauris, tempor at orci a, volutpat consectetur libero. In hac habitasse platea dictumst. Pellentesque finibus leo in mauris faucibus, eget convallis nulla euismod. Aenean sed rutrum sapien. Integer ultricies dapibus mollis. Nunc nec magna augue. Ut eu suscipit turpis, id tristique ligula. Mauris ut diam at neque tincidunt imperdiet nec et justo. Etiam eget elit ac augue dignissim accumsan. Duis facilisis vestibulum dolor, ut venenatis enim tincidunt vitae. Pellentesque a lacus eget justo porttitor mollis. Donec et tellus blandit, tincidunt nulla ac, consequat lorem. Curabitur placerat dictum elit at pretium.

src/bin/46_input_and_output.rs

@@ -0,0 +1,56 @@
+use std::io::{self, Read, Write};
+
+fn main() {
+    // types that implement the Read traits are Readers and have method for byte oriented input
+    // types that implement the BufRead traits are buffered readers and have methods for reading lines of texts and so forth
+    // types that implement the Write traits are Writers and have methods for byte oriented output
+    //
+    // Readers are values that your program can read bytes values from
+    // std::fs::File
+    // std::net::TcpStreams
+    // std::io::StdIn
+    //
+    // Writers are values that your progam can write byte values to
+    // std::fs::File
+    // std::net::TcpStreams
+    // std::io::StdOut
+    // Vec<u8>
+    //
+    // Personal Notes:
+    // it is possible to write generic code that works for across the input and output channel
+    // std::io::Read::read(&mut self, buf)
+    fn generic_copy<R: Read, W: Write>(reader: &mut R, writer: &mut W) -> io::Result<u64> {
+        let mut buf = [0; 8 * 1024];
+        let mut written = 0;
+
+        loop {
+            let len = match reader.read(&mut buf) {
+                Ok(0) => return Ok(written),
+                Ok(len) => len,
+                Err(e) => {
+                    println!("✅ Error: {e:?}");
+                    return Err(e);
+                }
+            };
+
+            writer.write_all(&buf[..len])?;
+            written += len as u64;
+        }
+    }
+
+    let mut input_file = std::fs::File::open("hello.txt").unwrap();
+    let mut output_file = std::fs::File::create("sample_file.txt").unwrap();
+
+    println!("Input File: {input_file:?}");
+    println!("Output File: {output_file:?}");
+
+    let copied = generic_copy(&mut input_file, &mut output_file).unwrap();
+    println!("Copied: {copied}");
+
+    // Readers have several methods for reading data and they all take a mutabel reference to the reader itself
+    // .read(&mut buff) reads some data from the data source and stores them in the buffer, the read method reads up until the len of buff
+    // .read_to_end(&mut Vec<u8>): this reads all the data in the data source into the Vector
+    // .read_to_string(&mut String): same as above but appends the data to the given String
+    // ,read_exact(&mut buf): Reads exactly enough data to fill the buffer, if the reader runs out of data before the buffer length, an Error is returned
+    //
+}