README
Tr
Resetter
- ::newReader::new
- ::new_dictReader::new_dict
- ::flushWriter::flush
- ::newWriter::new
- ::new_dictWriter::new_dict
- ::resetWriter::reset
V
err_checksum
V
err_dictionary
V
err_header

zlib

MoonBit zlib: provide simplified zlib format compressed data.

zlib

algorithm

compress

moonbit

Download zip

Author

gmlewis

Version

0.20.16

License

Apache-2.0

Repository

github.com/gmlewis/moonbit-zlib

Last updated

last year

Downloads

58K

#gmlewis/zlib

This is a simplified zlib format compressed data package based on Go's implementation: https://cs.opensource.google/go/go/+/refs/tags/go1.23.3:src/compress/zlib/reader.go which has the copyright notice:

// Copyright 2009 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

#Status

The code has been updated to support compiler:

$ moon version --all
moon 0.1.20250704 (608fa55 2025-07-04) ~/.moon/bin/moon
moonc v0.6.20 ~/.moon/bin/moonc
moonrun 0.1.20250704 (608fa55 2025-07-04) ~/.moon/bin/moonrun

Resetter

source

pub(open) trait Resetter {
  reset(Self, @gmlewis/flate.Reader
Reader, @gmlewis/io.Slice
Slice[Byte]) -> @gmlewis/io.IOError
IOError?
}

Resetter resets a ReadCloser returned by [Reader::new] or [Reader::new_dict] to switch to a new underlying Reader. This permits reusing a ReadCloser instead of allocating a new one.

Reader

source

type Reader

impl Closer for Reader

fn close(self : Reader) -> @gmlewis/io.IOError
IOError?

source

Calling close does not close the wrapped [io.Reader] originally passed to [Reader::new]. In order for the ZLIB checksum to be verified, the reader must be fully consumed until the [io.eof].

impl Reader for Reader

impl Resetter for Reader

Reader::new

source

fn Reader::new(r : @gmlewis/flate.Reader
Reader) -> (@gmlewis/io.ReadCloser
ReadCloser, @gmlewis/io.IOError
IOError?)

Reader::new creates a new ReadCloser. Reads from the returned ReadCloser read and decompress data from r. If r does not implement [io.ByteReader], the decompressor may read more data than necessary from r. It is the caller's responsibility to call close on the ReadCloser when done.

The [io.ReadCloser] returned by Reader::new also implements [Resetter].

Reader::new_dict

source

fn Reader::new_dict(r : @gmlewis/flate.Reader
Reader, dict : @gmlewis/io.Slice
Slice[Byte]) -> (@gmlewis/io.ReadCloser
ReadCloser, @gmlewis/io.IOError
IOError?)

Reader::new_dict is like [Reader::new] but uses a preset dictionary. Reader::new_dict ignores the dictionary if the compressed data does not refer to it. If the compressed data refers to a different dictionary, Reader::new_dict returns [err_dictionary].

The ReadCloser returned by Reader::new_dict also implements [Resetter].

Writer

source

type Writer

impl Closer for Writer

impl Writer for Writer

fn write(self : Writer, p : @gmlewis/io.Slice
Slice[Byte]) -> (Int, @gmlewis/io.IOError
IOError?)

source

write writes a compressed form of p to the underlying io.Writer. The compressed bytes are not necessarily flushed until the Writer is closed or explicitly flushed.

Writer::flush

source

fn Writer::flush(self : Writer) -> @gmlewis/io.IOError
IOError?

Writer::new

source

fn Writer::new(w : @gmlewis/io.Writer
Writer) -> Writer

Writer::new_dict

source

fn Writer::new_dict(w : @gmlewis/io.Writer
Writer, dict : @gmlewis/io.Slice
Slice[Byte]) -> Writer

Writer::reset

source

fn Writer::reset(self : Writer, w : @gmlewis/io.Writer
Writer) -> Unit

err_checksum

source

let err_checksum : @gmlewis/io.IOError
IOError

err_checksum is returned when reading ZLIB data that has an invalid checksum.

err_dictionary

source

let err_dictionary : @gmlewis/io.IOError
IOError

err_dictionary is returned when reading ZLIB data that has an invalid dictionary.

err_header

source

let err_header : @gmlewis/io.IOError
IOError

err_header is returned when reading ZLIB data that has an invalid header.

Source Files

Site source Report issue Packages Build queue Skills Statistics

zlib

#gmlewis/zlib

#Status

#Resetter

#Reader

#Reader::new

#Reader::new_dict

#Writer

#Writer::flush

#Writer::new

#Writer::new_dict

#Writer::reset

#err_checksum

#err_dictionary

#err_header

Source Files

Resetter

Reader

Reader::new

Reader::new_dict

Writer

Writer::flush

Writer::new

Writer::new_dict

Writer::reset

err_checksum

err_dictionary

err_header