Use caret notation for any control characters

Author: clue

composer.json

@@ -21,6 +21,7 @@
         "clue/json-stream": "~0.1.0"
     },
     "require-dev": {
-        "clue/tar-react": "~0.1.0"
+        "clue/tar-react": "~0.1.0",
+        "clue/caret-notation": "~0.2.0"
     }
 }

examples/copy.php

@@ -9,6 +9,7 @@
 use Clue\React\Docker\Factory;
 use Clue\React\Tar\Decoder;
 use React\Stream\ReadableStreamInterface;
+use Clue\CaretNotation\Encoder;
 
 $container = isset($argv[1]) ? $argv[1] : 'asd';
 $file = isset($argv[2]) ? $argv[2] : '/etc/passwd';
@@ -23,11 +24,14 @@
 
 $tar = new Decoder();
 
-$tar->on('entry', function ($header, ReadableStreamInterface $file) {
+// use caret notation for any control characters expect \t, \r and \n
+$caret = new Encoder("\t\r\n");
+
+$tar->on('entry', function ($header, ReadableStreamInterface $file) use ($caret) {
     // write each entry to the console output
-    echo '########## ' . $header['filename'] . ' ##########' . PHP_EOL;
-    $file->on('data', function ($chunk) {
-        echo $chunk;
+    echo '########## ' . $caret->encode($header['filename']) . ' ##########' . PHP_EOL;
+    $file->on('data', function ($chunk) use ($caret) {
+        echo $caret->encode($chunk);
     });
 });