1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

rdoc updated.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@18597 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
akr 2008-08-13 23:45:31 +00:00
parent abfd87c230
commit ae8522ff7e

View file

@ -1430,8 +1430,8 @@ check_econv(VALUE self)
/*
* call-seq:
* primitive_convert(input_buffer, output_buffer, output_bufsize) -> symbol
* primitive_convert(input_buffer, output_buffer, output_bufsize, flags) -> symbol
* primitive_convert(input_buffer, output_buffer, output_byteoffset, output_bytesize) -> symbol
* primitive_convert(input_buffer, output_buffer, output_byteoffset, output_bytesize, flags) -> symbol
*
* possible flags:
* Encoding::Converter::PARTIAL_INPUT # input buffer may be part of larger input
@ -1446,17 +1446,24 @@ check_econv(VALUE self)
* primitive_convert converts input_buffer into output_buffer.
*
* input_buffer and output_buffer should be a string.
* output_bufsize and flags should be an integer.
* output_byteoffset should be an integer or nil.
* output_bytesize and flags should be an integer.
*
* primitive_convert convert the content of input_buffer from beginning
* and store the result into output_buffer.
*
* output_byteoffset and output_bytesize specify the region which
* the converted result is stored.
* output_byteoffset specifies the start position in output_buffer in bytes.
* If output_byteoffset is nil, output_buffer.bytesize is assumed.
* output_bytesize specifies maximum number of bytes.
* After conversion, output_buffer is resized to
* output_byteoffset + actually converted number of bytes.
*
* primitive_convert drops the first part of input_buffer.
* the dropped part is converted in output_buffer or
* buffered in Encoding::Converter object.
*
* output_buffer is resized to output_bufsize bytes at maximum.
*
* primitive_convert stops conversion when one of following condition met.
* - invalid byte sequence found in input buffer (:invalid_input)
* - character not representable in output encoding (:undefined_conversion)