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
/// Macro used to generate a write/read tuple /// from sequence of operations. /// /// # Remarks /// Due to internal limitations assigning a /// different name to a variable in the capture /// is not valid: /// ```compile_fail /// // Won't compile!! /// seq!( /// Bar { a: a1, b: b1 }, /// a1: be_u8 => /// b1: be_u8 => /// ) /// ``` /// While reading variables used are owned copies of the /// values, while writing the values are references to /// those values, so it's necessary that you always use /// either as_ref() or to_owned() to collapse the two /// states into a reference or an owned copy. /// ``` /// use std::io::Cursor; /// use bin_io::{ seq, count, read }; /// use bin_io::numbers::{ be_u8, be_i16 }; /// /// #[derive(Debug, PartialEq, Eq)] /// struct Foo { /// a: Vec<i16> /// } /// /// /* Won't compile /// let tuple = seq!( /// Foo { a }, /// len: be_u8(), a.len() as _ => /// a: count(be_i16(), len as usize) => /// ); /// */ /// /// let tuple = seq!( /// Foo { a }, /// len: be_u8(), a.len() as _ => /// a: count(be_i16(), len.to_owned() as usize) => /// ); /// /// let mut vec = vec![ 0x02, 0x00, 0x01, 0x00, 0x02 ]; /// let mut cursor = Cursor::new(&mut vec); /// /// let foo = read(&mut cursor, tuple) /// .unwrap(); /// /// assert_eq!(foo, Foo { a: vec![ 1, 2 ] }); /// ``` /// # Examples /// ``` /// use std::io::Cursor; /// use bin_io::{ seq, skip, count, bind, read }; /// use bin_io::numbers::{ be_u8, be_u16, le_u16, be_i32 }; /// use bin_io::strings::null_utf16; /// /// mod bar { /// pub struct Foo { /// pub a: u8, /// pub b: u16, /// pub c: Vec<i32>, /// pub d: String, /// } /// } /// /// let tuple = seq!( /// // Here we specify wich variables /// // are inside Foo /// bar::Foo { a, b, c, d }, /// /// // And now we start the definition /// bind(be_u8(), 0x50) => /// a: be_u8() => /// b: le_u16() => /// skip(be_u16(), 1557) => /// c: count(be_i32(), b.to_owned() as usize) => /// d: null_utf16() => /// ); /// /// # let mut vec = vec![0; 8]; /// # vec[0] = 0x50; /// # let mut cursor = Cursor::new(vec); /// # let r = &mut cursor; /// /// let test = read(r, tuple) /// .unwrap(); /// ``` /// `seq!` is compatible with multiple data structures /// ``` /// use std::io::Cursor; /// use bin_io::{ seq, read, bind }; /// use bin_io::numbers::{ be_i8, be_i16, be_i32, be_i64 }; /// /// mod foo { /// pub struct Bar1; /// pub struct Bar2(pub i32); /// pub struct Bar3 { pub a: i64 } /// } /// /// let void = seq!( /// (), /// bind(be_i8(), -20) => /// ); /// /// let bar1 = seq!( /// foo::Bar1, /// bind(be_i16(), 30) => /// ); /// /// let bar2 = seq!( /// foo::Bar2(a), /// a: be_i32() => /// ); /// /// let bar3 = seq!( /// foo::Bar3 { a }, /// a: be_i64() => /// ); /// /// # let vec = vec![0; 15]; /// # let mut cursor = Cursor::new(vec); /// # let a = read(&mut cursor, void); /// # let b = read(&mut cursor, bar1); /// # let c = read(&mut cursor, bar2); /// # let d = read(&mut cursor, bar3); /// ``` /// Sometimes you need extra variables during reading, but you don't /// want them in your final struct (imagine length/value based formats), /// with `seq!` you can do that too! /// ``` /// use std::io::Cursor; /// use bin_io::{ seq, read, count }; /// use bin_io::numbers::{ be_u8, be_i16 }; /// /// #[derive(Debug, PartialEq, Eq)] /// struct Foo { /// a: Vec<i16> /// } /// /// let tuple = seq!( /// // Capture everything normally /// Foo { a }, /// // Give the field a default value or some expression to initialize it /// // Remember: this value is only used during writing and not reading /// length: be_u8(), a.len() as u8 => /// a: count(be_i16(), length.to_owned() as _) => /// ); /// /// let vec = vec![ 0x2, 0x0, 0x50, 0x0, 0x60 ]; /// let mut cursor = Cursor::new(vec); /// /// let foo = read(&mut cursor, tuple) /// .unwrap(); /// /// assert_eq!(foo, Foo { a: vec![ 0x50, 0x60 ] }) /// ``` #[macro_export] macro_rules! seq { ($($ty:ident)::+ { $($field:ident),* }, $($rest:tt)*) => { (|r: &mut _| { $crate::seq!(__impl r $($ty)::* { $($field),* }, r, $($rest)*) }, |w: &mut _, v: &_| { let $($ty)::* { $($field),* } = v; $crate::seq!(__impl w w, $($rest)*); Ok(()) }) }; ($($ty:ident)::+ ( $($field:ident),* ), $($rest:tt)*) => { (|r: &mut _| { $crate::seq!(__impl r $($ty)::* ( $($field),* ), r, $($rest)*) }, |w: &mut _, v: &_| { let $($ty)::* ( $($field),* ) = v; $crate::seq!(__impl w w, $($rest)*); Ok(()) }) }; ($($ty:ident)::+, $($rest:tt)*) => { (|r: &mut _| { $crate::seq!(__impl r $($ty)::*, r, $($rest)*) }, |w: &mut _, v: &_| { let $($ty)::* = v; $crate::seq!(__impl w w, $($rest)*); Ok(()) }) }; ((), $($rest:tt)*) => { (|r: &mut _| { $crate::seq!(__impl r (), r, $($rest)*) }, |w: &mut _, v: &_| { $crate::seq!(__impl w w, $($rest)*); Ok(()) }) }; (__impl r $e:expr, $r:ident, ) => { Ok($e) }; (__impl r $e:expr, $r:ident, $name:ident : $expr:expr => $($rest:tt)*) => { { let $name = $crate::read($r, $expr)?; $crate::seq!(__impl r $e, $r, $($rest)*) } }; (__impl r $e:expr, $r:ident, $name:ident : $expr:expr, $def:expr => $($rest:tt)*) => { { let $name = $crate::read($r, $expr)?; $crate::seq!(__impl r $e, $r, $($rest)*) } }; (__impl r $e:expr, $r:ident, $expr:expr => $($rest:tt)*) => { { let _: () = $crate::read($r, $expr)?; $crate::seq!(__impl r $e, $r, $($rest)*) } }; (__impl w $w:ident, ) => {}; (__impl w $w:ident, $name:ident : $expr:expr => $($rest:tt)*) => { { $crate::write($w, $name, $expr)?; $crate::seq!(__impl w $w, $($rest)*); } }; (__impl w $w:ident, $name:ident : $expr:expr, $def:expr => $($rest:tt)*) => { { let $name = &$def; $crate::write($w, $name, $expr)?; $crate::seq!(__impl w $w, $($rest)*); } }; (__impl w $w:ident, $expr:expr => $($rest:tt)*) => { { $crate::write($w, &(), $expr)?; $crate::seq!(__impl w $w, $($rest)*); } }; } /// Macro used to remove boilerplate code /// from a function definition. /// /// # Examples /// ``` /// use std::io::{ Read, Write }; /// /// use bin_io::{ ReadFn, WriteFn }; /// use bin_io::numbers::be_u8; /// /// // Without boilerplate /// pub fn my_parser_1<R: Read, W: Write>() /// -> (impl ReadFn<R, u8>, impl WriteFn<W, u8>) { /// be_u8() /// } /// /// // With boilerplate /// use bin_io::boilerplate; /// /// boilerplate!( /// pub fn my_parser_2() -> u8 { /// be_u8() /// } /// ); /// /// ``` #[macro_export] macro_rules! boilerplate { ($vis:vis fn $name:ident ( $($arg:ident : $ty:ty),* ) -> $ret:ty { $($tt:tt)* } ) => { $vis fn $name <R: std::io::Read, W: std::io::Write> ( $( $arg : $ty )* ) -> (impl $crate::ReadFn<R, $ret>, impl $crate::WriteFn<W, $ret>) { $($tt)* } }; }