class Zlib::GzipWriter

Zlib::GzipWriter 是一个用于写入 gzip 文件的类。 GzipWriter 应与 IO 实例或类似 IO 的对象一起使用。

以下两个示例生成相同的结果。

Zlib::GzipWriter.open('hoge.gz') do |gz|
  gz.write 'jugemu jugemu gokou no surikire...'
end

File.open('hoge.gz', 'w') do |f|
  gz = Zlib::GzipWriter.new(f)
  gz.write 'jugemu jugemu gokou no surikire...'
  gz.close
end

要使其行为与 gzip(1) 相同，请运行以下命令

orig = 'hoge.txt'
Zlib::GzipWriter.open('hoge.gz') do |gz|
  gz.mtime = File.mtime(orig)
  gz.orig_name = orig
  gz.write IO.binread(orig)
end

注意：由于 Ruby finalizer 的限制，您必须显式关闭 GzipWriter 对象，通过 Zlib::GzipWriter#close 等。否则，GzipWriter 将无法写入 gzip 页脚，并会生成损坏的 gzip 文件。

Public Class Methods

Zlib::GzipWriter.new(io, level = nil, strategy = nil, options = {})

Source

static VALUE
rb_gzwriter_initialize(int argc, VALUE *argv, VALUE obj)
{
    struct gzfile *gz;
    VALUE io, level, strategy, opt = Qnil;
    int err;

    if (argc > 1) {
        opt = rb_check_convert_type(argv[argc-1], T_HASH, "Hash", "to_hash");
        if (!NIL_P(opt)) argc--;
    }

    rb_scan_args(argc, argv, "12", &io, &level, &strategy);
    TypedData_Get_Struct(obj, struct gzfile, &gzfile_data_type, gz);

    /* this is undocumented feature of zlib */
    gz->level = ARG_LEVEL(level);
    err = deflateInit2(&gz->z.stream, gz->level, Z_DEFLATED,
                       -MAX_WBITS, DEF_MEM_LEVEL, ARG_STRATEGY(strategy));
    if (err != Z_OK) {
        raise_zlib_error(err, gz->z.stream.msg);
    }
    gz->io = io;
    ZSTREAM_READY(&gz->z);
    rb_gzfile_ecopts(gz, opt);

    if (rb_respond_to(io, id_path)) {
        /* File#path may raise IOError in case when a path is unavailable */
        rb_rescue2(gzfile_initialize_path_partial, obj, NULL, Qnil, rb_eIOError, (VALUE)0);
    }

    return obj;
}

创建一个与 io 关联的 GzipWriter 对象。level 和 strategy 应与 Zlib::Deflate.new 的参数相同。 GzipWriter 对象将 gzip 压缩数据写入 io。io 必须响应与 IO#write 行为相同的 write 方法。

options 哈希可用于设置数据的编码。:external_encoding、:internal_encoding 和 :encoding 可在 IO::new 中设置。

Zlib::GzipWriter.open(filename, level=nil, strategy=nil) { |gz| ... }

Source

static VALUE
rb_gzwriter_s_open(int argc, VALUE *argv, VALUE klass)
{
    return gzfile_s_open(argc, argv, klass, "wb");
}

打开指定为 filename 的文件以写入 gzip 压缩数据，并返回一个与该文件关联的 GzipWriter 对象。有关此方法的更多详细信息，请参阅 Zlib::GzipWriter.new 和 Zlib::GzipFile.wrap。

Public Instance Methods

<< (p1)

Source

#define rb_gzwriter_addstr  rb_io_addstr

与 IO 相同。

comment= (p1)

Source

static VALUE
rb_gzfile_set_comment(VALUE obj, VALUE str)
{
    struct gzfile *gz = get_gzfile(obj);
    VALUE s;
    char *p;

    if (gz->z.flags & GZFILE_FLAG_HEADER_FINISHED) {
        rb_raise(cGzError, "header is already written");
    }
    s = rb_str_dup(rb_str_to_str(str));
    p = memchr(RSTRING_PTR(s), '\0', RSTRING_LEN(s));
    if (p) {
        rb_str_resize(s, p - RSTRING_PTR(s));
    }
    gz->comment = s;
    return str;
}

指定 gzip 标头中的注释（str）。

flush(flush=nil)

Source

static VALUE
rb_gzwriter_flush(int argc, VALUE *argv, VALUE obj)
{
    struct gzfile *gz = get_gzfile(obj);
    VALUE v_flush;
    int flush;

    rb_scan_args(argc, argv, "01", &v_flush);

    flush = FIXNUMARG(v_flush, Z_SYNC_FLUSH);
    if (flush != Z_NO_FLUSH) {  /* prevent Z_BUF_ERROR */
        zstream_run(&gz->z, (Bytef*)"", 0, flush);
    }

    gzfile_write_raw(gz);
    if (rb_respond_to(gz->io, id_flush)) {
        rb_funcall(gz->io, id_flush, 0);
    }
    return obj;
}

刷新 GzipWriter 对象的所有内部缓冲区。flush 的含义与 Zlib::Deflate#deflate 中的相同。如果省略 flush，则使用 Zlib::SYNC_FLUSH。将 Zlib::NO_FLUSH 作为 flush 值没有意义。

mtime= (p1)

Source

static VALUE
rb_gzfile_set_mtime(VALUE obj, VALUE mtime)
{
    struct gzfile *gz = get_gzfile(obj);
    VALUE val;

    if (gz->z.flags & GZFILE_FLAG_HEADER_FINISHED) {
        rb_raise(cGzError, "header is already written");
    }

    val = rb_Integer(mtime);
    gz->mtime = NUM2UINT(val);
    gz->z.flags |= GZFILE_FLAG_MTIME_IS_SET;

    return mtime;
}

指定 gzip 标头中的修改时间（mtime）。使用 Integer。

设置 gzip 标头中的 mtime 不会影响生成文件的 mtime。展开 gzip 文件的不同实用程序可能会使用 mtime 标头。例如，gunzip 实用程序可以使用 `-N` 标志，该标志会将结果文件的 mtime 设置为标头中的值。默认情况下，许多工具会将展开文件的 mtime 设置为 gzip 文件的 mtime，而不是标头中的 mtime。

如果您不设置 mtime，默认值将是压缩开始时的时间。将值设置为 0 表示没有可用时间戳。

orig_name= (p1)

Source

static VALUE
rb_gzfile_set_orig_name(VALUE obj, VALUE str)
{
    struct gzfile *gz = get_gzfile(obj);
    VALUE s;
    char *p;

    if (gz->z.flags & GZFILE_FLAG_HEADER_FINISHED) {
        rb_raise(cGzError, "header is already written");
    }
    s = rb_str_dup(rb_str_to_str(str));
    p = memchr(RSTRING_PTR(s), '\0', RSTRING_LEN(s));
    if (p) {
        rb_str_resize(s, p - RSTRING_PTR(s));
    }
    gz->orig_name = s;
    return str;
}

指定 gzip 标头中的原始名称（str）。

pos ()

Source

static VALUE
rb_gzfile_total_in(VALUE obj)
{
    return rb_uint2inum(get_gzfile(obj)->z.stream.total_in);
}

到目前为止读取的总输入字节数。

也别名为：tell

print (*args)

Source

#define rb_gzwriter_print  rb_io_print

与 IO 相同。

printf (*args)

Source

#define rb_gzwriter_printf  rb_io_printf

与 IO 相同。

putc (p1)

Source

static VALUE
rb_gzwriter_putc(VALUE obj, VALUE ch)
{
    struct gzfile *gz = get_gzfile(obj);
    char c = NUM2CHR(ch);

    gzfile_write(gz, (Bytef*)&c, 1);
    return ch;
}

与 IO 相同。

puts (*args)

Source

#define rb_gzwriter_puts  rb_io_puts

与 IO 相同。

tell ()

到目前为止读取的总输入字节数。

别名：pos

write (*args)

Source

static VALUE
rb_gzwriter_write(int argc, VALUE *argv, VALUE obj)
{
    struct gzfile *gz = get_gzfile(obj);
    size_t total = 0;

    while (argc-- > 0) {
        VALUE str = *argv++;
        if (!RB_TYPE_P(str, T_STRING))
            str = rb_obj_as_string(str);
        if (gz->enc2 && gz->enc2 != rb_ascii8bit_encoding()) {
            str = rb_str_conv_enc(str, rb_enc_get(str), gz->enc2);
        }
        gzfile_write(gz, (Bytef*)RSTRING_PTR(str), RSTRING_LEN(str));
        total += RSTRING_LEN(str);
        RB_GC_GUARD(str);
    }
    return SIZET2NUM(total);
}

与 IO 相同。