Merge pull request #456 from webrtc-rs/anton/273-partial-read-2

[sctp] Include buffer size in `ErrShortBuffer`

Author: yngrtc

sctp/src/association/association_test.rs

@@ -740,12 +740,12 @@ async fn test_assoc_reliable_short_buffer() -> Result<()> {
 
     let mut buf = vec![0u8; 3];
     let result = s1.read_sctp(&mut buf).await;
-    assert!(result.is_err(), "expected error to be io.ErrShortBuffer");
+    assert!(result.is_err(), "expected error to be ErrShortBuffer");
     if let Err(err) = result {
         assert_eq!(
             err,
-            Error::ErrShortBuffer,
-            "expected error to be io.ErrShortBuffer"
+            Error::ErrShortBuffer { size: 3 },
+            "expected error to be ErrShortBuffer"
         );
     }
 

sctp/src/error.rs

@@ -209,8 +209,8 @@ pub enum Error {
     ErrOutboundPacketTooLarge,
     #[error("Stream closed")]
     ErrStreamClosed,
-    #[error("Short buffer to be filled")]
-    ErrShortBuffer,
+    #[error("Short buffer (size: {size:?}) to be filled")]
+    ErrShortBuffer { size: usize },
     #[error("Io EOF")]
     ErrEof,
     #[error("Invalid SystemTime")]

sctp/src/queue/queue_test.rs

@@ -795,7 +795,11 @@ fn test_reassembly_queue_detect_buffer_too_short() -> Result<()> {
     let result = rq.read(&mut buf);
     assert!(result.is_err(), "read() should not succeed");
     if let Err(err) = result {
-        assert_eq!(err, Error::ErrShortBuffer, "read() should not succeed");
+        assert_eq!(
+            err,
+            Error::ErrShortBuffer { size: 8 },
+            "read() should not succeed"
+        );
     }
     assert_eq!(rq.get_num_bytes(), 0, "num bytes mismatch");
 

sctp/src/queue/reassembly_queue.rs

@@ -286,7 +286,7 @@ impl ReassemblyQueue {
                 buf[n_written..n_written + n].copy_from_slice(&c.user_data[..n]);
                 n_written += n;
                 if n < to_copy {
-                    err = Some(Error::ErrShortBuffer);
+                    err = Some(Error::ErrShortBuffer { size: buf.len() });
                 }
             }
         }

sctp/src/stream/mod.rs

@@ -195,7 +195,7 @@ impl Stream {
             };
 
             match result {
-                Ok(_) | Err(Error::ErrShortBuffer) => return result,
+                Ok(_) | Err(Error::ErrShortBuffer { .. }) => return result,
                 Err(_) => {
                     // wait for the next chunk to become available
                     self.read_notifier.notified().await;