Merge #18

18: Don't give the full buffer to handler functions r=bspeice a=bspeice

Much simpler from an API perspective, unlikely to be a real performance issue.
bors r+

Co-authored-by: Bradlee Speice <bradlee@speice.io>

aeron-rs/src/client/concurrent/ringbuffer.rs

@@ -209,17 +209,15 @@ where
         Ok(true)
     }
 
-    /// Read messages from the ring buffer and dispatch to `handler`, up to `message_count_limit`
+    /// Read messages from the ring buffer and dispatch to `handler`, up to `message_count_limit`.
+    /// The handler is given the message type identifier and message body as arguments.
     ///
     /// NOTE: The C++ API will stop reading and clean up if an exception is thrown in the handler
     /// function; by contrast, the Rust API makes no attempt to catch panics and currently
     /// has no way of stopping reading once started.
-    // QUESTION: Is there a better way to handle dispatching the handler function?
-    // We can't give it a `&dyn AtomicBuffer` because of the monomorphized generic functions,
-    // don't know if having a separate handler trait would be helpful.
     pub fn read_n<F>(&mut self, mut handler: F, message_count_limit: usize) -> Result<usize>
     where
-        F: FnMut(i32, &A, IndexT, IndexT) -> (),
+        F: FnMut(i32, &[u8]) -> (),
     {
         let head = self.buffer.get_i64(self.head_position_index)?;
         let head_index = (head & i64::from(self.capacity - 1)) as i32;
@@ -249,12 +247,10 @@ where
                 }
 
                 messages_read += 1;
-                handler(
+                let msg_start = record_descriptor::encoded_msg_offset(record_index) as usize;
-                    msg_type_id,
+                let msg_end =
-                    &self.buffer,
+                    msg_start + (record_length - record_descriptor::HEADER_LENGTH) as usize;
-                    record_descriptor::encoded_msg_offset(record_index),
+                handler(msg_type_id, &self.buffer[msg_start..msg_end]);
-                    record_length - record_descriptor::HEADER_LENGTH,
-                );
             }
             Ok(())
         })();
@@ -284,13 +280,14 @@ where
     }
 
     /// Read messages from the ring buffer and dispatch to `handler`, up to `message_count_limit`
+    /// The handler is given the message type identifier and message body as arguments.
     ///
     /// NOTE: The C++ API will stop reading and clean up if an exception is thrown in the handler
     /// function; by contrast, the Rust API makes no attempt to catch panics and currently
     /// has no way of stopping reading once started.
     pub fn read<F>(&mut self, handler: F) -> Result<usize>
     where
-        F: FnMut(i32, &A, IndexT, IndexT) -> (),
+        F: FnMut(i32, &[u8]) -> (),
     {
         self.read_n(handler, usize::max_value())
     }

aeron-rs/tests/many_to_one_ring_buffer.rs

@@ -222,7 +222,7 @@ fn should_read_single_message() {
         .unwrap();
 
     let mut times_called = 0;
-    let closure = |_, _buf: &Vec<u8>, _, _| {
+    let closure = |_, _: &[u8]| {
         times_called += 1;
     };
     let messages_read = buffer.read(closure);
@@ -260,7 +260,7 @@ fn should_not_read_single_message_part_way_through_writing() {
         .unwrap();
 
     let mut times_called = 0;
-    let closure = |_, _buf: &Vec<u8>, _, _| {
+    let closure = |_, _: &[u8]| {
         times_called += 1;
     };
     let messages_read = buffer.read(closure);
@@ -306,7 +306,7 @@ fn should_read_two_messages() {
         .unwrap();
 
     let mut times_called = 0;
-    let closure = |_, _buf: &Vec<u8>, _, _| {
+    let closure = |_, _: &[u8]| {
         times_called += 1;
     };
     let messages_read = buffer.read(closure);
@@ -359,7 +359,7 @@ fn should_limit_read_of_messages() {
         .unwrap();
 
     let mut times_called = 0;
-    let closure = |_, _buf: &Vec<u8>, _, _| {
+    let closure = |_, _: &[u8]| {
         times_called += 1;
     };
     let messages_read = buffer.read_n(closure, 1);