Subclass of Zlib::Error
When zlib returns a Z_STREAM_ERROR, usually if the stream state was inconsistent.
Zlib::ZStream is the abstract class for the stream which handles the compressed data. The operations are defined in the subclasses: Zlib::Deflate for compression, and Zlib::Inflate for decompression.
An instance of Zlib::ZStream has one stream (struct zstream in the source) and two variable-length buffers which associated to the input (next_in) of the stream and the output (next_out) of the stream. In this document, “input buffer” means the buffer for input, and “output buffer” means the buffer for output.
Data input into an instance of Zlib::ZStream are temporally stored into the end of input buffer, and then data in input buffer are processed from the beginning of the buffer until no more output from the stream is produced (i.e. until avail_out > 0 after processing). During processing, output buffer is allocated and expanded automatically to hold all output data.
Some particular instance methods consume the data in output buffer and return them as a String.
Here is an ascii art for describing above:
+================ an instance of Zlib::ZStream ================+
|| ||
|| +--------+ +-------+ +--------+ ||
|| +--| output |<---------|zstream|<---------| input |<--+ ||
|| | | buffer | next_out+-------+next_in | buffer | | ||
|| | +--------+ +--------+ | ||
|| | | ||
+===|======================================================|===+
| |
v |
"output data" "input data"
If an error occurs during processing input buffer, an exception which is a subclass of Zlib::Error is raised. At that time, both input and output buffer keep their conditions at the time when the error occurs.
Method Catalogue Many of the methods in this class are fairly low-level and unlikely to be of interest to users. In fact, users are unlikely to use this class directly; rather they will be interested in Zlib::Inflate and Zlib::Deflate.
The higher level methods are listed below.
exception to wait for reading by EAGAIN. see IO.select.
exception to wait for writing by EAGAIN. see IO.select.
exception to wait for reading by EINPROGRESS. see IO.select.
exception to wait for writing by EINPROGRESS. see IO.select.
HTTPGenericRequest is the parent of the Net::HTTPRequest class.
Do not use this directly; instead, use a subclass of Net::HTTPRequest.
Response class for Processing responses (status code 102).
The Processing response indicates that the server has received and is processing the request, but no response is available yet.
References:
Response class for Non-Authoritative Information responses (status code 203).
The Non-Authoritative Information response indicates that the server is a transforming proxy (such as a Web accelerator) that received a 200 OK response from its origin, and is returning a modified version of the origin’s response.
References:
Response class for URI Too Long responses (status code 414).
The URI provided was too long for the server to process.
References:
Response class for URI Too Long responses (status code 414).
The URI provided was too long for the server to process.
References:
Response class for Range Not Satisfiable responses (status code 416).
The request entity has a media type which the server or resource does not support.
References:
Response class for Request Header Fields Too Large responses (status code 431).
An individual header field is too large, or all the header fields collectively, are too large.
References:
Response class for Insufficient Storage (WebDAV) responses (status code 507).
The server is unable to store the representation needed to complete the request.
References:
Hash with completion search feature. See OptionParser::Completion.
Raises when a switch with mandatory argument has no argument.