fix!: make gix-packeline features additive.

For good measure, everything that was touched is marked as breaking change.

Author: djc

.github/workflows/ci.yml

@@ -540,41 +540,6 @@ jobs:
       - name: gix-pack with all features (including wasm)
         run: cargo build -p gix-pack --all-features --target "$TARGET"
 
-  check-packetline:
-    strategy:
-      fail-fast: false
-      matrix:
-        os:
-          - ubuntu-latest
-          # We consider this script read-only and its effect is the same everywhere.
-          # However, when changes are made to `etc/scripts/copy-packetline.sh`, re-enable the other platforms for testing.
-    #       - macos-latest
-    #       - windows-latest
-
-    runs-on: ${{ matrix.os }}
-
-    defaults:
-      run:
-        # Use `bash` even on Windows, if we ever reenable `windows-latest` for testing.
-        shell: bash
-
-    steps:
-      - uses: actions/checkout@v5
-        with:
-          persist-credentials: false
-      - name: Check that working tree is initially clean
-        run: |
-          set -x
-          git status
-          git diff --exit-code
-      - name: Regenerate gix-packetline-blocking/src
-        run: etc/scripts/copy-packetline.sh
-      - name: Check that gix-packetline-blocking/src was already up to date
-        run: |
-          set -x
-          git status
-          git diff --exit-code
-
   # Check that all `actions/checkout` in CI jobs have `persist-credentials: false`.
   check-no-persist-credentials:
     runs-on: ubuntu-latest
@@ -655,7 +620,6 @@ jobs:
       - test-32bit-windows-size-doc
       - lint
       - cargo-deny
-      - check-packetline
       - check-no-persist-credentials
       - check-blocking
 

Cargo.lock

@@ -239,7 +239,6 @@ members = [
     "gix-status",
     "gix-revision",
     "gix-packetline",
-    "gix-packetline-blocking",
     "gix-mailmap",
     "gix-macros",
     "gix-note",

Cargo.toml

@@ -22,7 +22,7 @@ gix-command = { version = "^0.6.3", path = "../gix-command" }
 gix-quote = { version = "^0.6.1", path = "../gix-quote" }
 gix-utils = { version = "^0.3.1", path = "../gix-utils" }
 gix-path = { version = "^0.10.21", path = "../gix-path" }
-gix-packetline-blocking = { version = "^0.19.2", path = "../gix-packetline-blocking" }
+gix-packetline = { version = "^0.19.2", path = "../gix-packetline", features = ["blocking-io"] }
 gix-attributes = { version = "^0.28.0", path = "../gix-attributes" }
 
 encoding_rs = "0.8.32"

etc/scripts/copy-packetline.sh

@@ -41,7 +41,7 @@ pub mod invoke {
             #[error("Failed to read or write to the process")]
             Io(#[from] std::io::Error),
             #[error(transparent)]
-            PacketlineDecode(#[from] gix_packetline_blocking::decode::Error),
+            PacketlineDecode(#[from] gix_packetline::decode::Error),
         }
 
         impl From<super::Error> for Error {
@@ -65,18 +65,19 @@ impl Client {
         versions: &[usize],
         desired_capabilities: &[&str],
     ) -> Result<Self, handshake::Error> {
-        let mut out =
-            gix_packetline_blocking::Writer::new(process.stdin.take().expect("configured stdin when spawning"));
+        let mut out = gix_packetline::write::blocking_io::Writer::new(
+            process.stdin.take().expect("configured stdin when spawning"),
+        );
         out.write_all(format!("{welcome_prefix}-client").as_bytes())?;
         for version in versions {
             out.write_all(format!("version={version}").as_bytes())?;
         }
-        gix_packetline_blocking::encode::flush_to_write(out.inner_mut())?;
+        gix_packetline::encode::blocking_io::flush_to_write(out.inner_mut())?;
         out.flush()?;
 
-        let mut input = gix_packetline_blocking::StreamingPeekableIter::new(
+        let mut input = gix_packetline::read::blocking_io::StreamingPeekableIter::new(
             process.stdout.take().expect("configured stdout when spawning"),
-            &[gix_packetline_blocking::PacketLineRef::Flush],
+            &[gix_packetline::PacketLineRef::Flush],
             false, /* packet tracing */
         );
         let mut read = input.as_read();
@@ -126,10 +127,10 @@ impl Client {
         for capability in desired_capabilities {
             out.write_all(format!("capability={capability}").as_bytes())?;
         }
-        gix_packetline_blocking::encode::flush_to_write(out.inner_mut())?;
+        gix_packetline::encode::blocking_io::flush_to_write(out.inner_mut())?;
         out.flush()?;
 
-        read.reset_with(&[gix_packetline_blocking::PacketLineRef::Flush]);
+        read.reset_with(&[gix_packetline::PacketLineRef::Flush]);
         let mut capabilities = HashSet::new();
         loop {
             buf.clear();
@@ -168,7 +169,7 @@ impl Client {
     ) -> Result<process::Status, invoke::Error> {
         self.send_command_and_meta(command, meta)?;
         std::io::copy(content, &mut self.input)?;
-        gix_packetline_blocking::encode::flush_to_write(self.input.inner_mut())?;
+        gix_packetline::encode::blocking_io::flush_to_write(self.input.inner_mut())?;
         self.input.flush()?;
         Ok(self.read_status()?)
     }
@@ -190,15 +191,15 @@ impl Client {
                 inspect_line(line.as_bstr());
             }
         }
-        self.out.reset_with(&[gix_packetline_blocking::PacketLineRef::Flush]);
+        self.out.reset_with(&[gix_packetline::PacketLineRef::Flush]);
         let status = self.read_status()?;
         Ok(status)
     }
 
     /// Return a `Read` implementation that reads the server process output until the next flush package, and validates
     /// the status. If the status indicates failure, the last read will also fail.
     pub fn as_read(&mut self) -> impl std::io::Read + '_ {
-        self.out.reset_with(&[gix_packetline_blocking::PacketLineRef::Flush]);
+        self.out.reset_with(&[gix_packetline::PacketLineRef::Flush]);
         ReadProcessOutputAndStatus {
             inner: self.out.as_read(),
         }
@@ -226,7 +227,7 @@ impl Client {
             buf.push_str(&value);
             self.input.write_all(&buf)?;
         }
-        gix_packetline_blocking::encode::flush_to_write(self.input.inner_mut())?;
+        gix_packetline::encode::blocking_io::flush_to_write(self.input.inner_mut())?;
         Ok(())
     }
 }
@@ -249,7 +250,7 @@ fn read_status(read: &mut PacketlineReader<'_>) -> std::io::Result<process::Stat
     if count > 0 && matches!(status, process::Status::Previous) {
         status = process::Status::Unset;
     }
-    read.reset_with(&[gix_packetline_blocking::PacketLineRef::Flush]);
+    read.reset_with(&[gix_packetline::PacketLineRef::Flush]);
     Ok(status)
 }
 
@@ -261,7 +262,7 @@ impl std::io::Read for ReadProcessOutputAndStatus<'_> {
     fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
         let num_read = self.inner.read(buf)?;
         if num_read == 0 {
-            self.inner.reset_with(&[gix_packetline_blocking::PacketLineRef::Flush]);
+            self.inner.reset_with(&[gix_packetline::PacketLineRef::Flush]);
             let status = read_status(&mut self.inner)?;
             if status.is_success() {
                 Ok(0)

gix-filter/Cargo.toml

@@ -12,9 +12,9 @@ pub struct Client {
     /// The negotiated version of the protocol.
     version: usize,
     /// A way to send packet-line encoded information to the process.
-    input: gix_packetline_blocking::Writer<std::process::ChildStdin>,
+    input: gix_packetline::write::blocking_io::Writer<std::process::ChildStdin>,
     /// A way to read information sent to us by the process.
-    out: gix_packetline_blocking::StreamingPeekableIter<std::process::ChildStdout>,
+    out: gix_packetline::read::blocking_io::StreamingPeekableIter<std::process::ChildStdout>,
 }
 
 /// A handle to facilitate typical server interactions that include the handshake and command-invocations.
@@ -24,9 +24,9 @@ pub struct Server {
     /// The negotiated version of the protocol, it's the highest supported one.
     version: usize,
     /// A way to receive information from the client.
-    input: gix_packetline_blocking::StreamingPeekableIter<std::io::StdinLock<'static>>,
+    input: gix_packetline::read::blocking_io::StreamingPeekableIter<std::io::StdinLock<'static>>,
     /// A way to send information to the client.
-    out: gix_packetline_blocking::Writer<std::io::StdoutLock<'static>>,
+    out: gix_packetline::write::blocking_io::Writer<std::io::StdoutLock<'static>>,
 }
 
 /// The return status of an [invoked command][Client::invoke()].
@@ -109,8 +109,5 @@ pub mod client;
 ///
 pub mod server;
 
-type PacketlineReader<'a, T = std::process::ChildStdout> = gix_packetline_blocking::read::WithSidebands<
-    'a,
-    T,
-    fn(bool, &[u8]) -> gix_packetline_blocking::read::ProgressAction,
->;
+type PacketlineReader<'a, T = std::process::ChildStdout> =
+    gix_packetline::read::blocking_io::WithSidebands<'a, T, fn(bool, &[u8]) -> gix_packetline::read::ProgressAction>;