{"header":{"message":"Refactor read_until","description":null,"timestamp":"2023-07-13T10:31:59.448464808Z","authors":[{}]},"hash":"AOJXTWBZA2DQBFTJZX2YTGAKIB62SKTEVJ7RRIBJNDSMC75DDQVQC","authors":[{"login":"CandyCorvid","key":"2nxySdD32H8TtzYpnH4CSW8jXS2rPVRjW8JNU3HGe7JX"}],"deps":{"hashes":[["AOJXTWBZA2DQBFTJZX2YTGAKIB62SKTEVJ7RRIBJNDSMC75DDQVQC","Refactor read_until"],["AA",null],["3SPNKI46URBW4PD3JRMBV5YV5W56N3SFUTK25VQEF2FUZ64ZDQPAC","Improve parsing. Add modules that were missed"],["DBKKKHC2ER7XAYR6HAFQ6I75M3OLDOSGCB5BTEP7X6XAZRSWKIRAC","Initial commit"],["AMTMTTJTF2XHEUC6ACP2PHP7GAFMFZRSJ47VJBKEO22X4ZGFIX7QC","Upgrade status parsing"],["ONQEIR5BV26QJSI3HY7B3MN6VWEGSZIXAIUIANJ5ZLR3QN3DFGEAC","WIP mime-type handling"]],"deps":["3SPNKI46URBW4PD3JRMBV5YV5W56N3SFUTK25VQEF2FUZ64ZDQPAC"],"known":["DBKKKHC2ER7XAYR6HAFQ6I75M3OLDOSGCB5BTEP7X6XAZRSWKIRAC","AMTMTTJTF2XHEUC6ACP2PHP7GAFMFZRSJ47VJBKEO22X4ZGFIX7QC","ONQEIR5BV26QJSI3HY7B3MN6VWEGSZIXAIUIANJ5ZLR3QN3DFGEAC"]},"hunks":[{"FileDel":{"deleted_names":[{"basename":"read_until.rs","metadata":0}],"del":{"EdgeMap":{"edges":[{"previous":"BLOCK | FOLDER","flag":"BLOCK | FOLDER | DELETED","from":{"change":3,"pos":15},"to":{"change":3,"start":17,"end":54},"introduced_by":3},{"previous":"BLOCK | FOLDER","flag":"BLOCK | FOLDER | DELETED","from":{"change":3,"pos":54},"to":{"change":3,"start":55,"end":55},"introduced_by":3}],"inode":{"change":3,"pos":55}}},"content_edges":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":55},"to":{"change":3,"start":56,"end":3632},"introduced_by":3}],"inode":{"change":3,"pos":55}},"content":[{"Del":"//! adapted from the answer to this question: https://users.rust-lang.org/t/bufread-read-until-with-two-byte-delimiter/47239/6\n//! playground link: https://play.rust-lang.org/?version=stable&mode=debug&edition=2018\nuse bstr::ByteSlice;\nuse std::io;\nuse std::io::BufRead;\n\n/// Find the delimiter in the excess and the buffer, and return:\n/// Whether it was located\n/// How much was read into the buffer\nfn step(excess: &[u8], delimeter: &[u8; N], buf: &mut Vec) -> (bool, usize) {\n // find the whole delimiter in the excess\n if let Some(i) = excess.find(&delimeter) {\n buf.extend_from_slice(&excess[..i + N]);\n return (true, i + N);\n }\n // find the delimiter if it is partly in the excess and partly in the buffer\n for n in 1..N {\n // the seam between buf and excess contains the delimter\n if buf.ends_with(&delimeter[..n]) && excess.starts_with(&delimeter[n..N]) {\n let used = N - n;\n // then extend buf to include what needed to be read past the split\n buf.extend_from_slice(&excess[..used]);\n return (true, used);\n }\n }\n buf.extend_from_slice(excess);\n (false, excess.len())\n}\n\npub fn read_until(\n reader: &mut R,\n delimeter: &[u8; N],\n buf: &mut Vec,\n) -> io::Result\nwhere\n R: BufRead + ?Sized,\n{\n let mut read = 0;\n loop {\n // read ahead\n let (done, used) = step(reader.fill_buf()?, delimeter, buf);\n reader.consume(used);\n // count the number of bytes consumed\n read += used;\n // done means we found it, used == 0 means eof\n if done || used == 0 {\n return Ok(read);\n }\n }\n}\n\n#[cfg(test)]\nmod test {\n use crate::read_until::read_until;\n use std::io::BufReader;\n\n #[test]\n fn read1() {\n let mut buf0: &[u8] = b\"ebfdefghijkl\";\n let mut buf1 = Vec::new();\n let exp = b\"ebf\";\n let mut bufread = BufReader::new(&mut buf0);\n read_until(&mut bufread, b\"f\", &mut buf1).unwrap();\n assert_eq!(buf1, exp);\n }\n\n #[test]\n fn read2() {\n let mut buf0: &[u8] = b\"ebfdefghijkl\";\n let mut buf1 = Vec::new();\n let exp = b\"ebfdef\";\n let mut bufread = BufReader::new(&mut buf0);\n read_until(&mut bufread, b\"ef\", &mut buf1).unwrap();\n assert_eq!(buf1, exp);\n }\n\n #[test]\n fn read3() {\n let mut buf0: &[u8] = b\"ebfdefghijkl\";\n let mut buf1 = Vec::new();\n let exp = b\"ebfdef\";\n\n let mut bufread = BufReader::new(&mut buf0);\n read_until(&mut bufread, b\"def\", &mut buf1).unwrap();\n assert_eq!(buf1, exp);\n }\n\n #[test]\n fn read4() {\n let mut buf0: &[u8] = b\"ebfdefghijkl\";\n let mut buf1 = Vec::new();\n let exp = b\"ebfdef\";\n\n let mut bufread = BufReader::new(&mut buf0);\n read_until(&mut bufread, b\"fdef\", &mut buf1).unwrap();\n assert_eq!(buf1, exp);\n }\n\n #[test]\n fn read5() {\n let mut buf0: &[u8] = b\"ebfdefghijkl\";\n let mut buf1 = Vec::new();\n let exp = b\"ebfdef\";\n\n let mut bufread = BufReader::new(&mut buf0);\n read_until(&mut bufread, b\"bfdef\", &mut buf1).unwrap();\n assert_eq!(buf1, exp);\n }\n\n #[test]\n fn read6() {\n let mut buf0: &[u8] = b\"ebfdefghijkl\";\n let mut buf1 = Vec::new();\n let exp = b\"ebfdef\";\n\n let mut bufread = BufReader::new(&mut buf0);\n read_until(&mut bufread, b\"ebfdef\", &mut buf1).unwrap();\n assert_eq!(buf1, exp);\n }\n}\n"}]}},{"Replacement":{"inode":{"change":3,"pos":3665},"path":"src/main.rs","line":3,"ins":{"up_context":[{"change":3,"pos":3684}],"down_context":[{"change":2,"pos":6831}],"flag":"BLOCK","start":0,"end":31,"inode":{"change":3,"pos":3665}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":3684},"to":{"change":3,"start":3684,"end":3712},"introduced_by":3}],"inode":{"change":3,"pos":3665}},"ins_contents":[{"Add":"use io::{BufReadExt, ReadExt};"}],"del_contents":[{"Del":"use read_until::read_until;\n"}]}},{"Replacement":{"inode":{"change":3,"pos":3665},"path":"src/main.rs","line":7,"ins":{"up_context":[{"change":3,"pos":3767}],"down_context":[{"change":3,"pos":3807}],"flag":"BLOCK","start":32,"end":80,"inode":{"change":3,"pos":3665}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":3767},"to":{"change":3,"start":51,"end":105},"introduced_by":3}],"inode":{"change":3,"pos":3665}},"ins_contents":[{"Add":" io::{BufReader, Result as ioResult, Write},"}],"del_contents":[{"Del":" io::{BufReader, Read, Result as ioResult, Write},\n"}]}},{"Edit":{"inode":{"change":3,"pos":3665},"path":"src/main.rs","line":14,"atom":{"EdgeMap":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":127},"to":{"change":3,"start":127,"end":143},"introduced_by":3}],"inode":{"change":3,"pos":3665}}},"contents":[{"Del":"mod read_until;\n"}]}},{"Replacement":{"inode":{"change":3,"pos":3665},"path":"src/main.rs","line":58,"ins":{"up_context":[{"change":2,"pos":7673}],"down_context":[{"change":2,"pos":7761}],"flag":"BLOCK","start":81,"end":156,"inode":{"change":3,"pos":3665}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":2,"pos":7673},"to":{"change":2,"start":7673,"end":7761},"introduced_by":2}],"inode":{"change":3,"pos":3665}},"ins_contents":[{"Add":" let body = stream.read_string().expect(\"failed to read body\");"}],"del_contents":[{"Del":" let body = read_response_string(&mut stream).expect(\"failed to read body\");\n"}]}},{"Replacement":{"inode":{"change":3,"pos":3665},"path":"src/main.rs","line":128,"ins":{"up_context":[{"change":3,"pos":525}],"down_context":[{"change":3,"pos":4768}],"flag":"BLOCK","start":157,"end":274,"inode":{"change":3,"pos":3665}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":525},"to":{"change":3,"start":525,"end":652},"introduced_by":3}],"inode":{"change":3,"pos":3665}},"ins_contents":[{"Add":" let status = stream"},{"Add":" .read_n::<2>()?"},{"Add":" .map(|s| s.checked_sub(b'0').expect(\"bad status fragment\"));"}],"del_contents":[{"Del":" let status = io::read_n::<2>(stream)?;\n let status = status.map(|s| s.checked_sub(b'0').expect(\"bad status fragment\"));\n"}]}},{"Replacement":{"inode":{"change":3,"pos":3665},"path":"src/main.rs","line":132,"ins":{"up_context":[{"change":3,"pos":4769}],"down_context":[{"change":3,"pos":4801}],"flag":"BLOCK","start":275,"end":308,"inode":{"change":3,"pos":3665}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":4769},"to":{"change":3,"start":653,"end":689},"introduced_by":3}],"inode":{"change":3,"pos":3665}},"ins_contents":[{"Add":" let c = stream.read_byte()?;"}],"del_contents":[{"Del":" let c = io::read_byte(stream)?;\n"}]}},{"Replacement":{"inode":{"change":3,"pos":3665},"path":"src/main.rs","line":140,"ins":{"up_context":[{"change":3,"pos":4960}],"down_context":[{"change":3,"pos":717}],"flag":"BLOCK","start":309,"end":375,"inode":{"change":3,"pos":3665}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":4960},"to":{"change":3,"start":4960,"end":5032},"introduced_by":3}],"inode":{"change":3,"pos":3665}},"ins_contents":[{"Add":" BufReader::new(&mut *stream).read_until(b\"\\r\\n\", &mut meta)?;"}],"del_contents":[{"Del":" read_until(&mut BufReader::new(&mut *stream), b\"\\r\\n\", &mut meta)?;\n"}]}},{"Edit":{"inode":{"change":3,"pos":3665},"path":"src/main.rs","line":153,"atom":{"EdgeMap":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":5074},"to":{"change":3,"start":972,"end":1039},"introduced_by":3},{"previous":"","flag":"DELETED","from":{"change":3,"pos":1039},"to":{"change":3,"start":5192,"end":5278},"introduced_by":3},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":5192},"to":{"change":3,"start":5192,"end":5278},"introduced_by":3},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":5633},"to":{"change":3,"start":5633,"end":5636},"introduced_by":3}],"inode":{"change":3,"pos":3665}}},"contents":[{"Del":"fn read_response_string(stream: &mut Stream) -> ioResult {\n"},{"Del":" let mut body = String::new();\n stream.read_to_string(&mut body)?;\n Ok(body)\n"},{"Del":"}\n\n"}]}},{"Replacement":{"inode":{"change":2,"pos":9554},"path":"src/io.rs","line":1,"ins":{"up_context":[{"change":2,"pos":9554}],"down_context":[{"change":2,"pos":9584}],"flag":"BLOCK","start":376,"end":750,"inode":{"change":2,"pos":9554}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":2,"pos":9554},"to":{"change":2,"start":9555,"end":9584},"introduced_by":2}],"inode":{"change":2,"pos":9554}},"ins_contents":[{"Add":"use std::io::{BufRead, Read, Result};"},{"Add":""},{"Add":"pub trait ReadExt {"},{"Add":" fn read_byte(&mut self) -> Result;"},{"Add":" fn read_n(&mut self) -> Result<[u8; N]>;"},{"Add":" fn read_string(&mut self) -> Result;"},{"Add":"}"},{"Add":""},{"Add":"pub trait BufReadExt {"},{"Add":" fn read_until("},{"Add":" &mut self,"},{"Add":" delimeter: &[u8; N],"},{"Add":" buf: &mut Vec,"},{"Add":" ) -> Result;"},{"Add":"}"}],"del_contents":[{"Del":"use std::io::{Read, Result};\n"}]}},{"Replacement":{"inode":{"change":2,"pos":9554},"path":"src/io.rs","line":17,"ins":{"up_context":[{"change":2,"pos":9585}],"down_context":[{"change":2,"pos":9695}],"flag":"BLOCK","start":751,"end":1187,"inode":{"change":2,"pos":9554}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":2,"pos":9585},"to":{"change":2,"start":9585,"end":9695},"introduced_by":2}],"inode":{"change":2,"pos":9554}},"ins_contents":[{"Add":"impl ReadExt for R {"},{"Add":" fn read_byte(&mut self) -> Result {"},{"Add":" let [c] = self.read_n::<1>()?;"},{"Add":" Ok(c)"},{"Add":" }"},{"Add":""},{"Add":" fn read_n(&mut self) -> Result<[u8; N]> {"},{"Add":" let mut buf = [0; N];"},{"Add":" self.read_exact(&mut buf)?;"},{"Add":" Ok(buf)"},{"Add":" }"},{"Add":" fn read_string(&mut self) -> Result {"},{"Add":" let mut body = String::new();"},{"Add":" self.read_to_string(&mut body)?;"},{"Add":" Ok(body)"},{"Add":" }"}],"del_contents":[{"Del":"pub(crate) fn read_byte(stream: &mut impl Read) -> Result {\n let [c] = read_n::<1>(stream)?;\n Ok(c)\n"}]}},{"Edit":{"inode":{"change":2,"pos":9554},"path":"src/io.rs","line":34,"atom":{"NewVertex":{"up_context":[{"change":2,"pos":9697}],"down_context":[{"change":2,"pos":9697}],"flag":"BLOCK","start":1188,"end":1505,"inode":{"change":2,"pos":9554}}},"contents":[{"Add":""},{"Add":"mod read_until {"},{"Add":" //! adapted from the answer to this question: https://users.rust-lang.org/t/bufread-read-until-with-two-byte-delimiter/47239/6"},{"Add":" //! playground link: https://play.rust-lang.org/?version=stable&mode=debug&edition=2018"},{"Add":" use bstr::ByteSlice;"},{"Add":" use std::io::BufRead;"},{"Add":" use std::io::Result;"}]}},{"Replacement":{"inode":{"change":2,"pos":9554},"path":"src/io.rs","line":42,"ins":{"up_context":[{"change":2,"pos":9698}],"down_context":[{"change":2,"pos":9852}],"flag":"BLOCK","start":1506,"end":5284,"inode":{"change":2,"pos":9554}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":2,"pos":9698},"to":{"change":2,"start":9698,"end":9852},"introduced_by":2}],"inode":{"change":2,"pos":9554}},"ins_contents":[{"Add":" use super::BufReadExt;"},{"Add":""},{"Add":" /// Find the delimiter in the excess and the buffer, and return:"},{"Add":" /// Whether it was located"},{"Add":" /// How much was read into the buffer"},{"Add":" fn step("},{"Add":" excess: &[u8],"},{"Add":" delimeter: &[u8; N],"},{"Add":" buf: &mut Vec,"},{"Add":" ) -> (bool, usize) {"},{"Add":" // find the whole delimiter in the excess"},{"Add":" if let Some(i) = excess.find(&delimeter) {"},{"Add":" buf.extend_from_slice(&excess[..i + N]);"},{"Add":" return (true, i + N);"},{"Add":" }"},{"Add":" // find the delimiter if it is partly in the excess and partly in the buffer"},{"Add":" for n in 1..N {"},{"Add":" // the seam between buf and excess contains the delimter"},{"Add":" if buf.ends_with(&delimeter[..n]) && excess.starts_with(&delimeter[n..N]) {"},{"Add":" let used = N - n;"},{"Add":" // then extend buf to include what needed to be read past the split"},{"Add":" buf.extend_from_slice(&excess[..used]);"},{"Add":" return (true, used);"},{"Add":" }"},{"Add":" }"},{"Add":" buf.extend_from_slice(excess);"},{"Add":" (false, excess.len())"},{"Add":" }"},{"Add":""},{"Add":" impl BufReadExt for R {"},{"Add":" fn read_until("},{"Add":" &mut self,"},{"Add":" delimiter: &[u8; N],"},{"Add":" buf: &mut Vec,"},{"Add":" ) -> Result {"},{"Add":" let mut read = 0;"},{"Add":" loop {"},{"Add":" // read ahead"},{"Add":" let (done, used) = step(self.fill_buf()?, delimiter, buf);"},{"Add":" self.consume(used);"},{"Add":" // count the number of bytes consumed"},{"Add":" read += used;"},{"Add":" // done means we found it, used == 0 means eof"},{"Add":" if done || used == 0 {"},{"Add":" return Ok(read);"},{"Add":" }"},{"Add":" }"},{"Add":" }"},{"Add":" }"},{"Add":""},{"Add":" #[cfg(test)]"},{"Add":" mod test {"},{"Add":" use super::BufReadExt;"},{"Add":" use std::io::BufReader;"},{"Add":""},{"Add":" #[test]"},{"Add":" fn read1() {"},{"Add":" let mut buf0: &[u8] = b\"ebfdefghijkl\";"},{"Add":" let mut buf1 = Vec::new();"},{"Add":" let exp = b\"ebf\";"},{"Add":" let mut bufread = BufReader::new(&mut buf0);"},{"Add":" bufread.read_until(b\"f\", &mut buf1).unwrap();"},{"Add":" assert_eq!(buf1, exp);"},{"Add":" }"},{"Add":""},{"Add":" #[test]"},{"Add":" fn read2() {"},{"Add":" let mut buf0: &[u8] = b\"ebfdefghijkl\";"},{"Add":" let mut buf1 = Vec::new();"},{"Add":" let exp = b\"ebfdef\";"},{"Add":" let mut bufread = BufReader::new(&mut buf0);"},{"Add":" bufread.read_until(b\"ef\", &mut buf1).unwrap();"},{"Add":" assert_eq!(buf1, exp);"},{"Add":" }"},{"Add":""},{"Add":" #[test]"},{"Add":" fn read3() {"},{"Add":" let mut buf0: &[u8] = b\"ebfdefghijkl\";"},{"Add":" let mut buf1 = Vec::new();"},{"Add":" let exp = b\"ebfdef\";"},{"Add":""},{"Add":" let mut bufread = BufReader::new(&mut buf0);"},{"Add":" bufread.read_until(b\"def\", &mut buf1).unwrap();"},{"Add":" assert_eq!(buf1, exp);"},{"Add":" }"},{"Add":""},{"Add":" #[test]"},{"Add":" fn read4() {"},{"Add":" let mut buf0: &[u8] = b\"ebfdefghijkl\";"},{"Add":" let mut buf1 = Vec::new();"},{"Add":" let exp = b\"ebfdef\";"},{"Add":""},{"Add":" let mut bufread = BufReader::new(&mut buf0);"},{"Add":" bufread.read_until(b\"fdef\", &mut buf1).unwrap();"},{"Add":" assert_eq!(buf1, exp);"},{"Add":" }"},{"Add":""},{"Add":" #[test]"},{"Add":" fn read5() {"},{"Add":" let mut buf0: &[u8] = b\"ebfdefghijkl\";"},{"Add":" let mut buf1 = Vec::new();"},{"Add":" let exp = b\"ebfdef\";"},{"Add":""},{"Add":" let mut bufread = BufReader::new(&mut buf0);"},{"Add":" bufread.read_until(b\"bfdef\", &mut buf1).unwrap();"},{"Add":" assert_eq!(buf1, exp);"},{"Add":" }"},{"Add":""},{"Add":" #[test]"},{"Add":" fn read6() {"},{"Add":" let mut buf0: &[u8] = b\"ebfdefghijkl\";"},{"Add":" let mut buf1 = Vec::new();"},{"Add":" let exp = b\"ebfdef\";"},{"Add":""},{"Add":" let mut bufread = BufReader::new(&mut buf0);"},{"Add":" bufread.read_until(b\"ebfdef\", &mut buf1).unwrap();"},{"Add":" assert_eq!(buf1, exp);"},{"Add":" }"},{"Add":" }"}],"del_contents":[{"Del":"pub(crate) fn read_n(stream: &mut impl Read) -> Result<[u8; N]> {\n let mut buf = [0; N];\n stream.read_exact(&mut buf)?;\n Ok(buf)\n"}]}}],"owner":"CandyCorvid","repo":"gemini","token":"P/q5Sq/H24L0m3Xhnu7TC3JaYWlRBqK/1cNypNO0blc=","login":null}

…

Dependencies

Change contents