класс Zlib::ZStream

Родитель:: Объект

Zlib::ZStream — это абстрактный класс для потока, обрабатывающего сжатые данные. Операции определены в подклассах: Zlib::Deflate для сжатия и Zlib::Inflate для распаковки.

Экземпляр Zlib::ZStream имеет один поток (структура zstream в исходном коде) и два буфера переменной длины, связанные с входными (next_in) и выходными (next_out) данными потока. В этом документе «входной буфер» означает буфер для входных данных, а «выходной буфер» — буфер для выходных данных.

Data входные данные в экземпляр Zlib::ZStream временно хранятся в конце входного буфера, а затем данные в входном буфере обрабатываются с начала буфера до тех пор, пока не будет получен больше выходных данных из потока (т.е. пока avail_out > 0 после обработки). Во время обработки выходной буфер автоматически выделяется и расширяется, чтобы содержать все выходные данные.

Некоторые особые методы экземпляра потребляют данные из выходного буфера и возвращают их как String.

Вот ASCII-арт для описания вышесказанного:

+================ an instance of Zlib::ZStream ================+
||                                                            ||
||     +--------+          +-------+          +--------+      ||
||  +--| output |<---------|zstream|<---------| input  |<--+  ||
||  |  | buffer |  next_out+-------+next_in   | buffer |   |  ||
||  |  +--------+                             +--------+   |  ||
||  |                                                      |  ||
+===|======================================================|===+
    |                                                      |
    v                                                      |
"output data"                                         "input data"

Если при обработке входного буфера произошла ошибка, генерируется исключение, являющееся подклассом Zlib::Error. В этот момент и входной, и выходной буферы сохраняют своё состояние на момент возникновения ошибки.

`Method` Каталог

Многие методы в этом классе довольно низкого уровня и вряд ли будут представлять интерес для пользователей. На самом деле, пользователям вряд ли придётся использовать этот класс напрямую; скорее, их заинтересуют Zlib::Inflate и Zlib::Deflate.

Методы более высокого уровня перечислены ниже.

Публичные методы экземпляров

adler ()

Исходный код

static VALUE
rb_zstream_adler(VALUE obj)
{
    return rb_uint2inum(get_zstream(obj)->stream.adler);
}

Возвращает контрольную сумму adler-32.

avail_in ()

Исходный код

static VALUE
rb_zstream_avail_in(VALUE obj)
{
    struct zstream *z;
    TypedData_Get_Struct(obj, struct zstream, &zstream_data_type, z);
    return INT2FIX(NIL_P(z->input) ? 0 : (int)(RSTRING_LEN(z->input)));
}

Возвращает количество байтов данных в буфере ввода. Обычно возвращает 0.

avail_out ()

Исходный код

static VALUE
rb_zstream_avail_out(VALUE obj)
{
    struct zstream *z;
    TypedData_Get_Struct(obj, struct zstream, &zstream_data_type, z);
    return rb_uint2inum(z->stream.avail_out);
}

Возвращает количество байтов свободного места в буфере вывода. Так как свободное место выделяется автоматически, этот метод обычно возвращает 0.

avail_out= (p1)

Исходный код

static VALUE
rb_zstream_set_avail_out(VALUE obj, VALUE size)
{
    struct zstream *z = get_zstream(obj);

    zstream_expand_buffer_into(z, FIX2INT(size));
    return size;
}

Выделяет size байтов свободного места в буфере вывода. Если в буфере уже больше чем size байтов, буфер усекается. Так как свободное место выделяется автоматически, обычно использовать этот метод не нужно.

close ()

Исходный код

static VALUE
rb_zstream_end(VALUE obj)
{
    zstream_end(get_zstream(obj));
    return Qnil;
}

Закрывает поток. Все операции над закрытым потоком вызовут исключение.

Также алиасируется как: end

closed? ()

Исходный код

static VALUE
rb_zstream_closed_p(VALUE obj)
{
    struct zstream *z;
    TypedData_Get_Struct(obj, struct zstream, &zstream_data_type, z);
    return ZSTREAM_IS_READY(z) ? Qfalse : Qtrue;
}

Возвращает true, если поток закрыт.

Также алиасируется как: ended?

data_type ()

Исходный код

static VALUE
rb_zstream_data_type(VALUE obj)
{
    return INT2FIX(get_zstream(obj)->stream.data_type);
}

Определяет тип данных, которые были введены в поток. Возвращаемое значение — это либо BINARY, либо ASCII, либо UNKNOWN.

end ()

Закрывает поток. Все операции над закрытым потоком вызовут исключение.

Псевдоним для: close

ended? ()

Возвращает true, если поток закрыт.

Псевдоним для: closed?

finish → Строка

finish { |chunk| ... } → null

Исходный код

static VALUE
rb_zstream_finish(VALUE obj)
{
    struct zstream *z = get_zstream(obj);

    zstream_run(z, (Bytef*)"", 0, Z_FINISH);

    return zstream_detach_buffer(z);
}

Завершает поток и очищает буфер вывода. Если передан блок, каждый фрагмент передается в блок, пока буфер ввода не будет очищен в буфер вывода.

finished? ()

Исходный код

static VALUE
rb_zstream_finished_p(VALUE obj)
{
    return ZSTREAM_IS_FINISHED(get_zstream(obj)) ? Qtrue : Qfalse;
}

Возвращает true, если поток завершен.

Также алиасируется как: stream_end?

flush_next_in → ввод

Исходный код

static VALUE
rb_zstream_flush_next_in(VALUE obj)
{
    struct zstream *z;
    VALUE dst;

    TypedData_Get_Struct(obj, struct zstream, &zstream_data_type, z);
    dst = zstream_detach_input(z);
    return dst;
}

flush_next_out → Строка

flush_next_out { |chunk| ... } → null

Исходный код

static VALUE
rb_zstream_flush_next_out(VALUE obj)
{
    struct zstream *z;

    TypedData_Get_Struct(obj, struct zstream, &zstream_data_type, z);

    return zstream_detach_buffer(z);
}

Очищает буфер вывода и возвращает все данные в этом буфере. Если передан блок, каждый фрагмент передается в блок, пока текущий буфер вывода не будет очищен.

reset ()

Исходный код

static VALUE
rb_zstream_reset(VALUE obj)
{
    zstream_reset(get_zstream(obj));
    return Qnil;
}

Сбрасывает и инициализирует поток. Все данные в буферах ввода и вывода удаляются.

stream_end? ()

Возвращает true, если поток завершен.

Псевдоним для: finished?

total_in ()

Исходный код

static VALUE
rb_zstream_total_in(VALUE obj)
{
    return rb_uint2inum(get_zstream(obj)->stream.total_in);
}

Возвращает общее количество байтов входных данных в поток. FIXME

total_out ()

Исходный код

static VALUE
rb_zstream_total_out(VALUE obj)
{
    return rb_uint2inum(get_zstream(obj)->stream.total_out);
}

Возвращает общее количество байтов выходных данных из потока. FIXME

Ruby Core © 1993–2024 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

класс Zlib::ZStream

Method Каталог

`Method` Каталог