aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOnur Gündüz <ogunduz@gmail.com>2026-09-29 14:06:34 +0200
committerOnur Gündüz <ogunduz@gmail.com>2026-09-29 14:06:34 +0200
commit171c32577ef504ec3b8ea09bb8df00fd6be7a13d (patch)
tree30844eb0884a36fbabd9e7cb45e6226d139577df /README.md
parente3eb58307419a9f7314e061c393d579fd14b75ab (diff)
downloadele-171c32577ef504ec3b8ea09bb8df00fd6be7a13d.tar.gz
ele-171c32577ef504ec3b8ea09bb8df00fd6be7a13d.zip
Bound JSON record reads and report oversized input
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4c1656b..056f76c 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ cargo install --path .
## CLI usage
```bash
-usage: aip-filter [-p|--print] <expr> [file...]
+usage: aip-filter [-p|--print] [--max-record-bytes N] [--] <expr> [file...]
```
* `--print` prints the parsed expression instead of evaluating it.
@@ -21,6 +21,8 @@ usage: aip-filter [-p|--print] <expr> [file...]
* Input is newline-delimited JSON, with one value per line. Matching lines are preserved.
* An empty filter copies the selected input unchanged; `--print` with an empty filter prints nothing.
* Invalid JSON lines are reported and skipped. Any invalid JSON or input/output error causes a nonzero exit status.
+* Records are limited to 8 MiB by default, including the newline. `--max-record-bytes N` sets a positive byte limit. Oversized records are reported and skipped without buffering the rest of the line; later records are still processed and the exit status indicates failure. The limit does not apply to an empty filter, which copies bytes directly.
+* Memory depends on the largest allowed record and its parsed JSON values, not on the total number of records. The record limit is not a process-memory limit.
### Matching rules