Skip to content
FutureBlitz

    Install

    Import std.compress.zstd

    std.compress.zstd

    Zstd (RFC 8878), over zstd. Its Compress and Decompress work at once, and its Compressor and Decompressor take bytes in turn and give what came out of them so far, for data that comes in parts. Levels go from 1, the fastest, to 22, the smallest, and are 3 by default, as zstd's; those past 19 take much more memory. Each frame has its content's checksum, and a Compress's says its size. A Decompress reads frames one after another, as zstd does, skipping skippable ones.

    std/compress/zstd.fb

    Types

    Zstd struct 

    Public Struct Zstd

    Zstd's frames, of .zst files.

    std/compress/zstd.fb, line 24

    • @PanicsAtCaller Public Static Method Compress(data: UInt8[], level: Int = 3): UInt8[] static method #

      The data, compressed at the level. Panics when the level isn't from 1 to 22.

    • @PanicsAtCaller Public Static Method Decompress(data: UInt8[], limit: Int = MOST_BYTES): UInt8[] Throws IOError static method #

      The bytes the data is compressed from, each frame's after the last's, or an IOError when it isn't Zstd's, ends too soon, or would come to more than limit bytes. Panics when the limit is negative.

    ZstdCompressor class 

    Public Class ZstdCompressor Implements Coder

    Zstd's bytes made in turn: Add gives what compressing the bytes it takes has made so far, and Finish what's left, which ends a frame, and starts again.

    std/compress/zstd.fb, line 54

    • @PanicsAtCaller Public New(level: Int = 3) constructor #

      Panics when the level isn't from 1 to 22.

    • Public Method Add(data: UInt8[]): UInt8[] method #

      What data comes to so far, which can be nothing yet.

      Doc from std.compress.codec.Coder.Add.

    • Public Method Finish(): UInt8[] method #

      What's left once all the bytes are added, which ends what it makes, and starts it again.

      Doc from std.compress.codec.Coder.Finish.

    ZstdDecompressor class 

    Public Class ZstdDecompressor Implements Coder

    Zstd's bytes taken in turn, a frame after another: Add gives what the bytes it takes decompress to so far, and Finish what's left once they've all been added, and starts again. Each throws an IOError when the bytes aren't Zstd's or would come to more than the limit, and Finish when they end too soon.

    std/compress/zstd.fb, line 84

    • @PanicsAtCaller Public New(limit: Int = MOST_BYTES) constructor #

      Panics when the limit is negative.

    • Public Method Add(data: UInt8[]): UInt8[] Throws IOError method #

      What data comes to so far, which can be nothing yet.

      Doc from std.compress.codec.Coder.Add.

    • Public Method Finish(): UInt8[] Throws IOError method #

      What's left once all the bytes are added, which ends what it makes, and starts it again.

      Doc from std.compress.codec.Coder.Finish.

    Report an issue with this page or with FutureBlitz on GitHub.