szip #

Description:

szip is a thin wrapper around miniz.h, which in turn is "Single C source file zlib-replacement library, originally from code.google.com/p/miniz". It provides utility functions for reading/writing .zip files.

TODO Merge/move under vlib/compress/zip .

fn extract_zip_to_dir(file string, dir string) !bool

extract zip file to directory

fn open(name string, level CompressionLevel, mode OpenMode) !&Zip

open opens zip archive with compression level using the given mode.
name: the name of the zip file to open.
level: can be any value of the CompressionLevel enum.
mode: can be any value of the OpenMode enum.

fn zip_files(path_to_file []string, path_to_export_zip string) !

zip files (full path) to zip file

fn zip_folder(folder string, zip_file string, opt ZipFolderOptions) !

zip_folder zips all entries in folder recursively to the zip file at zip_file.
Empty folders will be included, unless specified otherwise in opt.

type Fn_on_extract_entry = fn (&&char, &&char) int

fn (mut z Zip) close()

close closes the zip archive, releases resources - always finalize.

fn (mut zentry Zip) open_entry(name string) !

open_entry opens an entry by name in the zip archive.
For zip archive opened in 'w' or 'a' mode the function will append a new entry. In readonly mode the function tries to locate the entry in global dictionary.

fn (mut z Zip) open_entry_by_index(index int) !

open_entry_by_index opens an entry by index in the archive.

fn (mut zentry Zip) close_entry()

close_entry closes a zip entry, flushes buffer and releases resources.

fn (mut zentry Zip) name() string

name returns a local name of the current zip entry.
The main difference between user's entry name and local entry name is optional relative path.
Following .ZIP File Format Specification - the path stored MUST not contain a drive or device letter, or a leading slash.
All slashes MUST be forward slashes '/' as opposed to backwards slashes '' for compatibility with Amiga and UNIX file systems etc.

fn (mut zentry Zip) index() !int

index returns an index of the current zip entry.

fn (mut zentry Zip) is_dir() !bool

is_dir determines if the current zip entry is a directory entry.

fn (mut zentry Zip) size() u64

size returns an uncompressed size of the current zip entry.

fn (mut zentry Zip) crc32() u32

crc32 returns CRC-32 checksum of the current zip entry.

fn (mut zentry Zip) write_entry(data []u8) !

write_entry compresses an input buffer for the current zip entry.

fn (mut zentry Zip) create_entry(name string) !

create_entry compresses a file for the current zip entry.

fn (mut zentry Zip) read_entry() !voidptr

read_entry extracts the current zip entry into output buffer.
The function allocates sufficient memory for an output buffer.
NOTE: remember to release the memory allocated for an output buffer.
for large entries, please take a look at zip_entry_extract function.

fn (mut zentry Zip) read_entry_buf(buf voidptr, in_bsize int) !int

read_entry_buf extracts the current zip entry into user specified buffer

fn (mut zentry Zip) extract_entry(path string) !

extract_entry extracts the current zip entry into output file.

fn (mut zentry Zip) total() !int

total returns the number of all entries (files and directories) in the zip archive.

enum CompressionLevel {
	no_compression = 0
	best_speed = 1
	best_compression = 9
	uber_compression = 10
	default_level = 6
	default_compression = -1
}

CompressionLevel lists compression levels, see in "thirdparty/zip/miniz.h"

enum OpenMode {
	write
	read_only
	append
}

OpenMode lists the opening modes .write: opens a file for reading/extracting (the file must exists).
.read_only: creates an empty file for writing.
.append: appends to an existing archive.

struct ZipFolderOptions {
	omit_empty_folders bool
}