Skip to content

Add brotli format support #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add brotli format support #80

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c674923
Add brotli in index.bs
saschanaz Nov 24, 2025
952cd72
Rfc7932
saschanaz Nov 25, 2025
5b643ac
Brackets for IDL names
saschanaz Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,38 +36,45 @@ A <dfn>compression context</dfn> is the internal state maintained by a compressi
Note: This format is referred to as "deflate" for consistency with HTTP Content-Encodings. See [[RFC7230 obsolete]] section 4.2.2.

* Implementations must be "compliant" as described in [[!RFC1950]] section 2.3.
* Field values described as invalid in [[!RFC1950]] must not be created by CompressionStream, and are errors for DecompressionStream.
* Field values described as invalid in [[!RFC1950]] must not be created by {{CompressionStream}}, and are errors for {{DecompressionStream}}.
* The only valid value of the `CM` (Compression method) part of the `CMF` field is 8.
* The `FDICT` flag is not supported by these APIs, and will error the stream if set.
* The `FLEVEL` flag is ignored by DecompressionStream.
* It is an error for DecompressionStream if the `ADLER32` checksum is not correct.
* The `FLEVEL` flag is ignored by {{DecompressionStream}}.
* It is an error for {{DecompressionStream}} if the `ADLER32` checksum is not correct.
* It is an error if there is additional input data after the `ADLER32` checksum.

: {{CompressionFormat/deflate-raw}}
:: "The DEFLATE algorithm" [[!RFC1951]]

* Implementations must be "compliant" as described in [[!RFC1951]] section 1.4.
* Non-[[!RFC1951]]-conforming blocks must not be created by CompressionStream, and are errors for DecompressionStream.
* Non-[[!RFC1951]]-conforming blocks must not be created by {{CompressionStream}}, and are errors for {{DecompressionStream}}.
* It is an error if there is additional input data after the final block indicated by the `BFINAL` flag.

: {{CompressionFormat/gzip}}
:: "GZIP file format" [[!RFC1952]]

* Implementations must be "compliant" as described in [[!RFC1952]] section 2.3.1.2.
* Field values described as invalid in [[!RFC1952]] must not be created by CompressionStream, and are errors for DecompressionStream.
* Field values described as invalid in [[!RFC1952]] must not be created by {{CompressionStream}}, and are errors for {{DecompressionStream}}.
* The only valid value of the `CM` (Compression Method) field is 8.
* The `FTEXT` flag must be ignored by DecompressionStream.
* The `FTEXT` flag must be ignored by {{DecompressionStream}}.
* If the `FHCRC` field is present, it is an error for it to be incorrect.
* The contents of any `FEXTRA`, `FNAME` and `FCOMMENT` fields must be ignored by DecompressionStream, except to verify that they are terminated correctly.
* The contents of the `MTIME`, `XFL` and `OS` fields must be ignored by DecompressionStream.
* The contents of any `FEXTRA`, `FNAME` and `FCOMMENT` fields must be ignored by {{DecompressionStream}}, except to verify that they are terminated correctly.
* The contents of the `MTIME`, `XFL` and `OS` fields must be ignored by {{DecompressionStream}}.
* It is an error if `CRC32` or `ISIZE` do not match the decompressed data.
* A `gzip` stream may only contain one "member".
* It is an error if there is additional input data after the end of the "member".

: {{CompressionFormat/brotli}}
:: "Brotli Compressed Data Format" [[!RFC7932]]
Copy link
Member Author

@saschanaz saschanaz Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to make CompressionFormat sorted, should I do the same here?

Copy link
Member

@annevk annevk Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah good point, we should keep the same order everywhere.


* Implementation must be "compliant" as described in [[!RFC7932]] section 1.4.
* Non-[[!RFC7932]]-conforming blocks must not be created by {{CompressionStream}}, and are errors for {{DecompressionStream}}.

# Interface `CompressionStream` # {#compression-stream}

<pre class="idl">
enum CompressionFormat {
"brotli",
"deflate",
"deflate-raw",
"gzip",
Expand Down