класс Zlib::Inflate

static VALUE
rb_inflate_s_inflate(VALUE obj, VALUE src)
{
    struct zstream z;
    VALUE dst, args[2];
    int err;

    StringValue(src);
    zstream_init_inflate(&z);
    err = inflateInit(&z.stream);
    if (err != Z_OK) {
        raise_zlib_error(err, z.stream.msg);
    }
    ZSTREAM_READY(&z);

    args[0] = (VALUE)&z;
    args[1] = src;
    dst = rb_ensure(inflate_run, (VALUE)args, zstream_ensure_end, (VALUE)&z);

    return dst;
}

Распаковывает string. Вызывает исключение Zlib::NeedDict, если для распаковки требуется предустановленный словарь.

Этот метод почти эквивалентен следующему коду:

def inflate(string)
  zstream = Zlib::Inflate.new
  buf = zstream.inflate(string)
  zstream.finish
  zstream.close
  buf
end

См. также Zlib.deflate

static VALUE
rb_inflate_initialize(int argc, VALUE *argv, VALUE obj)
{
    struct zstream *z;
    VALUE wbits;
    int err;

    rb_scan_args(argc, argv, "01", &wbits);
    TypedData_Get_Struct(obj, struct zstream, &zstream_data_type, z);

    err = inflateInit2(&z->stream, ARG_WBITS(wbits));
    if (err != Z_OK) {
        raise_zlib_error(err, z->stream.msg);
    }
    ZSTREAM_READY(z);

    return obj;
}

Создаёт новый поток распаковки. window_bits задаёт размер буфера истории и может принимать следующие значения:

0

Использовать размер окна из заголовка zlib сжатого потока.

(8..15)

Переопределяет размер окна, указанный в заголовке потока распаковки. Размер окна должен быть не меньше размера окна сжатого потока.

Больше 15

Прибавьте 32 к window_bits, чтобы включить декодирование zlib и gzip с автоматическим определением заголовка, или прибавьте 16, чтобы декодировать только формат gzip (для потока не в формате gzip будет вызвано исключение Zlib::DataError).

(-8..-15)

Включает режим raw deflate, в котором контрольное значение не генерируется и не проверяются контрольные значения в конце потока.

Этот режим предназначен для использования с другими форматами, использующими формат сжатых данных deflate, например zip, которые предоставляют собственные контрольные значения.

Пример

open "compressed.file" do |compressed_io|
  zi = Zlib::Inflate.new(Zlib::MAX_WBITS + 32)

  begin
    open "uncompressed.file", "w+" do |uncompressed_io|
      uncompressed_io << zi.inflate(compressed_io.read)
    end
  ensure
    zi.close
  end
end

static VALUE
rb_inflate_addstr(VALUE obj, VALUE src)
{
    struct zstream *z = get_zstream(obj);

    if (ZSTREAM_IS_FINISHED(z)) {
        if (!NIL_P(src)) {
            StringValue(src);
            zstream_append_buffer2(z, src);
        }
    }
    else {
        do_inflate(z, src);
        if (ZSTREAM_IS_FINISHED(z)) {
            zstream_passthrough_input(z);
        }
    }

    return obj;
}

То же, что и IO.

static VALUE
rb_inflate_add_dictionary(VALUE obj, VALUE dictionary)
{
    VALUE dictionaries = rb_ivar_get(obj, id_dictionaries);
    VALUE checksum = do_checksum(1, &dictionary, adler32);

    rb_hash_aset(dictionaries, checksum, dictionary);

    return obj;
}

Предоставляет потоку распаковки словарь, который может понадобиться в дальнейшем. Можно предоставить несколько словарей. Поток распаковки автоматически выберет подходящий пользовательский словарь на основе словаря, требуемого потоку.

static VALUE
rb_inflate_inflate(int argc, VALUE* argv, VALUE obj)
{
    struct zstream *z = get_zstream(obj);
    struct rb_zlib_inflate_arguments arguments = {z, argc, argv};
    return rb_mutex_synchronize(z->mutex, rb_inflate_inflate_body, (VALUE)&arguments);
}

Передаёт deflate_string потоку распаковки и возвращает выходные данные потока. При вызове этого метода очищаются как входной, так и выходной буферы потока. Если string равен nil, этот метод завершает поток, как и Zlib::ZStream#finish.

Если передан блок, в него передаются последовательно распакованные фрагменты из deflate_string, а возвращается nil.

Если передан именованный аргумент :buffer, отличный от nil:

• Аргумент :buffer должен быть объектом String и будет использоваться как выходной буфер. Этот параметр позволяет повторно использовать память, необходимую при распаковке.

• Если блок не передан, возвращаемым значением будет тот же объект, что и аргумент :buffer.

• Если блок передан, передаваемые ему фрагменты будут иметь то же значение, что и аргумент :buffer.

Вызывает исключение Zlib::NeedDict, если для распаковки требуется предустановленный словарь. Задайте словарь с помощью Zlib::Inflate#set_dictionary, а затем снова вызовите этот метод с пустой строкой, чтобы очистить поток:

inflater = Zlib::Inflate.new

begin
  out = inflater.inflate compressed
rescue Zlib::NeedDict
  # ensure the dictionary matches the stream's required dictionary
  raise unless inflater.adler == Zlib.adler32(dictionary)

  inflater.set_dictionary dictionary
  inflater.inflate ''
end

# ...

inflater.close

См. также Zlib::Inflate.new

static VALUE
rb_inflate_set_dictionary(VALUE obj, VALUE dic)
{
    struct zstream *z = get_zstream(obj);
    VALUE src = dic;
    int err;

    StringValue(src);
    err = inflateSetDictionary(&z->stream,
                               (Bytef*)RSTRING_PTR(src), RSTRING_LENINT(src));
    if (err != Z_OK) {
        raise_zlib_error(err, z->stream.msg);
    }

    return dic;
}

Задаёт предустановленный словарь и возвращает string. Этот метод доступен только после вызова исключения Zlib::NeedDict. Подробности см. в zlib.h.

static VALUE
rb_inflate_sync(VALUE obj, VALUE src)
{
    struct zstream *z = get_zstream(obj);

    StringValue(src);
    return zstream_sync(z, (Bytef*)RSTRING_PTR(src), RSTRING_LEN(src));
}

Добавляет string в конец входного буфера и пропускает данные до обнаружения точки полной очистки. Если такая точка найдена в буфере, этот метод очищает буфер и возвращает false. В противном случае он возвращает true, а следующие за точкой полной очистки данные сохраняются в буфере.

static VALUE
rb_inflate_sync_point_p(VALUE obj)
{
    struct zstream *z = get_zstream(obj);
    int err;

    err = inflateSyncPoint(&z->stream);
    if (err == 1) {
        return Qtrue;
    }
    if (err != Z_OK) {
        raise_zlib_error(err, z->stream.msg);
    }
    return Qfalse;
}

Дословная цитата из исходной документации:

What is this?

:)