From 6626730bfe2d8e954085ec86cffea16114fe6adf Mon Sep 17 00:00:00 2001 From: "Viral B. Shah" Date: Sun, 13 Aug 2023 16:37:35 -0400 Subject: [PATCH 1/5] Update README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 37be7fb..df09ded 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,34 @@ close(fh) See the [documentation](https://gzipjl.readthedocs.org/en/latest/) for additional information. + +## Notes + +- This interface is only for gzipped files, not the streaming zlib + compression interface. Internally, it depends on/uses the + streaming interface, but the gzip related functions are higher + level functions pertaining to gzip files only. +- `GZipStream` is an implementation of `IO` and can be used virtually + anywhere `IO` is used. +- This implementation mimics the `IOStream`{.interpreted-text + role="class"} implementation, and should be a drop-in replacement + for `IOStream`, with some caveats: + - `seekend` and `truncate` are not available + - `readuntil` is available, but is not very efficient. (But `readline` works fine.) + +In addition to [`open`](@ref), [`gzopen`](@ref), and [`gzdopen`](@ref), the +following `IO`/`IOStream` functions are supported: + +- `close()` +- `flush()` +- `seek()` +- `skip()` +- `position()` +- `eof()` +- `read()` +- `readuntil()` +- `readline()` +- `write()` +- `peek()` + +Due to limitations in `zlib`, `seekend` and `truncate` are not available. From 5ea85811e25062c9e5c4b8febe53b01e0faf1a03 Mon Sep 17 00:00:00 2001 From: "Viral B. Shah" Date: Sun, 13 Aug 2023 16:40:20 -0400 Subject: [PATCH 2/5] Update README.md --- README.md | 24 ++++++------------------ 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index df09ded..b271b0e 100644 --- a/README.md +++ b/README.md @@ -29,27 +29,15 @@ write(fh, s) close(fh) ``` +## Notes -See the [documentation](https://gzipjl.readthedocs.org/en/latest/) -for additional information. - -## Notes - -- This interface is only for gzipped files, not the streaming zlib - compression interface. Internally, it depends on/uses the - streaming interface, but the gzip related functions are higher - level functions pertaining to gzip files only. -- `GZipStream` is an implementation of `IO` and can be used virtually - anywhere `IO` is used. -- This implementation mimics the `IOStream`{.interpreted-text - role="class"} implementation, and should be a drop-in replacement - for `IOStream`, with some caveats: - - `seekend` and `truncate` are not available +- This interface is only for gzipped files, not the streaming zlib compression interface. Internally, it depends on/uses the streaming interface, but the gzip related functions are higher level functions pertaining to gzip files only. +- `GZipStream` is an implementation of `IO` and can be used virtually anywhere `IO` is used. +- This implementation mimics the `IOStream` implementation, and should be a drop-in replacement for `IOStream`, with some caveats: + - `seekend` and `truncate` are not available - `readuntil` is available, but is not very efficient. (But `readline` works fine.) -In addition to [`open`](@ref), [`gzopen`](@ref), and [`gzdopen`](@ref), the -following `IO`/`IOStream` functions are supported: - +In addition to [`open`](@ref), [`gzopen`](@ref), and [`gzdopen`](@ref), the following `IO`/`IOStream` functions are supported: - `close()` - `flush()` - `seek()` From dfded6587ae1558b0a6bb49a209502d489c701c8 Mon Sep 17 00:00:00 2001 From: "Viral B. Shah" Date: Sun, 13 Aug 2023 16:40:53 -0400 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b271b0e..ade7265 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ close(fh) - `seekend` and `truncate` are not available - `readuntil` is available, but is not very efficient. (But `readline` works fine.) -In addition to [`open`](@ref), [`gzopen`](@ref), and [`gzdopen`](@ref), the following `IO`/`IOStream` functions are supported: +In addition to [`open`], [`gzopen`], and [`gzdopen`], the following `IO`/`IOStream` functions are supported: - `close()` - `flush()` - `seek()` From 96bfae23d141c887414fdc085cf6a9b67fc8212b Mon Sep 17 00:00:00 2001 From: "Viral B. Shah" Date: Sun, 13 Aug 2023 16:41:12 -0400 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ade7265..faf775d 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ close(fh) - `seekend` and `truncate` are not available - `readuntil` is available, but is not very efficient. (But `readline` works fine.) -In addition to [`open`], [`gzopen`], and [`gzdopen`], the following `IO`/`IOStream` functions are supported: +In addition to `open`, `gzopen`, and `gzdopen`, the following `IO`/`IOStream` functions are supported: - `close()` - `flush()` - `seek()` From 3ad2d84ce5ca91c43adb6ef5453d23cb10e14004 Mon Sep 17 00:00:00 2001 From: "Viral B. Shah" Date: Sun, 13 Aug 2023 21:22:05 -0400 Subject: [PATCH 5/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index faf775d..ec623e1 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ This module provides a wrapper for the gzip related functions of unencumbered, lossless data-compression library. These functions allow the reading and writing of gzip files. +Documentation: https://gzipjl.readthedocs.org/en/latest/ + Usage -----