API

`#compress/zlib`

import: #compress/zlib

counts: 2 fns, 6 methods, 2 types, 0 consts, 0 ifaces

zlib Reader/Writer with Adler-32; dictionaries rejected.

`struct Reader`

XuAPI

pub struct Reader {
    pub data string
    pub sticky string
}

Purpose

Public struct `Reader`.

Parameters

data string: data
sticky string: field (string)

`struct Writer`

XuAPI

pub struct Writer {
    pub buf string
    pub out string
    pub closed bool
}

Purpose

Public struct `Writer`.

Parameters

buf string: buffer
out string: field (string)
closed bool: field (bool)

`new_reader`

XuAPI

pub fn new_reader(data string) Reader

Purpose

Construct reader.

Parameters

data string: data (string)

Returns

Reader — a value of this type

`new_writer`

XuAPI

pub fn new_writer() Writer

Purpose

Construct writer.

Parameters

none

Returns

Writer — a value of this type

`(&mut Reader) read_all`

XuAPI

pub fn (r &mut Reader) read_all() string

Purpose

Method on `&mut Reader`: read all. Throws on failure.

Parameters

r &mut Reader: receiver &mut Reader (exclusive borrow)

Returns

string — result string

`(&mut Writer) write`

XuAPI

pub fn (w &mut Writer) write(data &string) int

Purpose

Method on `&mut Writer`: write data and return the byte count. Throws on failure.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)
data &string: data (borrowed; caller keeps it; type &string)

Returns

int — bytes written

`(&mut Writer) write_string`

XuAPI

pub fn (w &mut Writer) write_string(s string) int

Purpose

Method on `&mut Writer`: write a string and return the byte count.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)
s string: source string (string)

Returns

int — bytes written

`(&mut Writer) close`

XuAPI

pub fn (w &mut Writer) close() int

Purpose

Method on `&mut Writer`: close the resource.

Parameters

w &mut Writer: receiver &mut Writer (exclusive borrow)

Returns

int — a value of this type

`(&Writer) bytes`

XuAPI

pub fn (w &Writer) bytes() string

Purpose

Method on `&Writer`: return the buffered bytes.

Parameters

w &Writer: receiver &Writer (borrow)

Returns

string — result string

`(&Writer) text`

XuAPI

pub fn (w &Writer) text() string

Purpose

Method on `&Writer`: return the current text.

Parameters

w &Writer: receiver &Writer (borrow)

Returns

string — result string