libfossil
fsl_zip_writer Struct Reference

A utility class for creating ZIP-format archives. More...

#include "util.h"

Collaboration diagram for fsl_zip_writer:

Data Fields

fsl_buffer body
 The buffer for the ZIP file body.
fsl_list dirs
 The current list of directory entries (as (char *)).
int32_t dosDate
 Current DOS-format date of the ZIP.
int32_t dosTime
 Current DOS-format time of the ZIP.
fsl_size_t entryCount
 Number of entries (files + dirs) added to the zip file so far.
char * rootDir
 An artificial root directory which gets prefixed to all inserted filenames.
fsl_buffer scratch
 Internal scratchpad for ops which often allocate small buffers.
fsl_buffer toc
 The buffer for the table of contents.
fsl_time_t unixTime
 Current Unix Epoch time of the ZIP.

Detailed Description

A utility class for creating ZIP-format archives.

All members are internal details and must not be mucked about with by the client. See fsl_zip_file_add() for an example of how to use it.

Note that it creates ZIP content in memory, as opposed to streaming it (it is not yet certain if abstractly streaming a ZIP is possible), so creating a ZIP file this way is exceedingly memory-hungry.

See also
fsl_zip_file_add()
fsl_zip_timestamp_set_julian()
fsl_zip_timestamp_set_unix()
fsl_zip_end()
fsl_zip_body()
fsl_zip_finalize()

Definition at line 5138 of file util.h.

Field Documentation

◆ body

fsl_buffer fsl_zip_writer::body

The buffer for the ZIP file body.

Definition at line 5167 of file util.h.

◆ dirs

fsl_list fsl_zip_writer::dirs

The current list of directory entries (as (char *)).

Definition at line 5176 of file util.h.

◆ dosDate

int32_t fsl_zip_writer::dosDate

Current DOS-format date of the ZIP.

Definition at line 5150 of file util.h.

◆ dosTime

int32_t fsl_zip_writer::dosTime

Current DOS-format time of the ZIP.

Definition at line 5146 of file util.h.

◆ entryCount

fsl_size_t fsl_zip_writer::entryCount

Number of entries (files + dirs) added to the zip file so far.

Definition at line 5142 of file util.h.

◆ rootDir

char* fsl_zip_writer::rootDir

An artificial root directory which gets prefixed to all inserted filenames.

Definition at line 5159 of file util.h.

◆ scratch

fsl_buffer fsl_zip_writer::scratch

Internal scratchpad for ops which often allocate small buffers.

Definition at line 5172 of file util.h.

◆ toc

fsl_buffer fsl_zip_writer::toc

The buffer for the table of contents.

Definition at line 5163 of file util.h.

◆ unixTime

fsl_time_t fsl_zip_writer::unixTime

Current Unix Epoch time of the ZIP.

Definition at line 5154 of file util.h.


The documentation for this struct was generated from the following file: