Merge pull request #17 from savi-lang/deprecate/pending-reads

Deprecate the `TCP.Engine.pending_reads` method.

Author: jemc

spec/TCP.Spec.savi

@@ -54,14 +54,14 @@
       |
         @env.err.print("[Echoer] Failed to get local and/or remote address")
       )
+
     | IO.Action.Read |
-      @io.pending_reads -> (bytes_available |
-        bytes val = @io.read_stream.extract_all
-        @env.err.print("[Echoer] Received: \(Inspect[bytes])")
-        @io.write_stream << bytes
-        try @io.flush! // TODO: should we flush automatically on close below?
-        @io.close
-      )
+      bytes val = @io.read_stream.extract_all
+      @env.err.print("[Echoer] Received: \(Inspect[bytes])")
+      @io.write_stream << bytes
+      try @io.flush! // TODO: should we flush automatically on close below?
+      @io.close
+
     | IO.Action.Closed |
       @env.err.print("[Echoer] Closed")
       @listener.dispose // ask the listener to close too
@@ -105,12 +105,10 @@
       @env.err.print(@io.connect_error.name)
 
     | IO.Action.Read |
-      @io.pending_reads -> (bytes_available |
-        if (bytes_available >= b"Hello, World!".size) (
-          bytes val = @io.read_stream.extract_all
-          @env.err.print("[EchoClient] Received: \(Inspect[bytes])")
-          @io.close
-        )
+      if (@io.read_stream.bytes_ahead_of_marker >= b"Hello, World!".size) (
+        bytes val = @io.read_stream.extract_all
+        @env.err.print("[EchoClient] Received: \(Inspect[bytes])")
+        @io.close
       )
 
     | IO.Action.Closed |

src/TCP.Engine.savi

@@ -51,12 +51,21 @@
         // This allows the listener to keep an accurate count of how many
         // connections have been opened so far.
         try @_listener.as!(IO.Actor(IO.Action)).io_deferred_action(IO.Action.ClosedChild)
-
-        // TODO: windows complete writes, flush-after-mute (pending writes logic from Pony)
-        // | IO.Action.Write |
-        //   ...
+        yield action
+
+      | IO.Action.Read |
+        if Platform.is_windows (
+          None // TODO: @_windows_complete_reads(arg)
+        |
+          @_pending_reads_unix -> (yield action)
+        )
+
+      // TODO: windows complete writes, flush-after-mute (pending writes logic from Pony)
+      // | IO.Action.Write |
+      //   ...
+      |
+        yield action
       )
-      yield action
     )
     @
 
@@ -67,21 +76,27 @@
   :fun ref flush!
     @write_stream.flush!
 
+  // TODO: Remove this deprecated method.
+  :: DEPRECATED: There's no need for this method anymore.
+  :: Loading pending reads into the read stream will now be handled
+  :: automatically by the TCP engine, which will yield an `IO.Action.Read`
+  :: action for each time a pending read is completed.
+  ::
+  :: So you can just remove this function call from your code and de-indent
+  :: the body of your yield block, such that it becomes part of the outer code.
+  :: If you need to know the number of bytes available, then you can call
+  :: `io.read_stream.bytes_ahead_of_marker` to find out.
   :fun ref pending_reads
     :yields USize for None
-    if Platform.is_windows (
-      None // TODO: @_windows_complete_reads(arg)
-    |
-      @_pending_reads_unix -> (bytes_available | yield bytes_available)
-    )
+    yield @read_stream.bytes_ahead_of_marker
     @
 
   :fun ref _pending_reads_unix None
-    :yields USize for None
+    :yields None for None
     while @io.is_readable (
       try (
         bytes_read = @read_stream.receive_from!(@io)
-        if (bytes_read > 0) (yield @read_stream.bytes_ahead_of_marker)
+        if (bytes_read > 0) (yield None)
       )
     )