compression.aug diagrams

Compression with zlib

Project overview · Compiled explanation

Sequences

Call arrows identify checked targets; loop and branch frames determine when they run. Open that target’s module to follow its implementation. Branches describe alternatives; loops describe repeated work. Native calls and interface dispatch stop at their declared contracts. Exit notes end that path; enclosing recovery and cleanup remain visible.

roundTrip

Source

Compress text with zlib, then restore its bytes within a fixed output limit.

Failures can raise CompressionError.

100%

Mermaid source

sequenceDiagram
    participant p0 as roundTrip
    participant p1 as aug-zlib/api
    p0->>p0: ”The world runs on language”.bytes()
    p0-->>p0: input: Bytes
    p0->>p1: compress(input=input)
    p1-->>p0: compressed: Bytes
    p0->>p1: decompress(input=compressed, maximumOutput=4096)
    p1-->>p0: decompress result: Bytes
    Note over p0: Return decompress(input=compressed, maximumOutput=4096)；<br/>required cleanup runs before exit
    Note over p0: May leave with checked errors: CompressionError

Called contracts

• roundTrip — compression.aug
• compress — package/@greenpandastudios/aug-zlib@0.2.0/api.aug
• decompress — package/@greenpandastudios/aug-zlib@0.2.0/api.aug