add example for buffer: argument of pack.

This commit is contained in:
Tanaka Akira 2021-10-25 12:25:13 +09:00
Родитель 66d09501c2
Коммит b74f9d656a
1 изменённых файлов: 10 добавлений и 0 удалений

10
pack.rb
Просмотреть файл

@ -33,6 +33,16 @@ class Array
# the offset, the rest of <i>offsetOfBuffer</i> are overwritten by the result.
# If it's shorter, the gap is filled with ``<code>\0</code>''.
#
# # packed data is appended by default
# [255].pack("C", buffer:"foo".b) #=> "foo\xFF"
#
# # "@0" (offset 0) specifies that packed data is filled from beginning.
# # Also, original data after packed data is removed. ("oo" is removed.)
# [255].pack("@0C", buffer:"foo".b) #=> "\xFF"
#
# # If the offset is bigger than the original length, \x00 is filled.
# [255].pack("@5C", buffer:"foo".b) #=> "foo\x00\x00\xFF"
#
# Note that ``buffer:'' option does not guarantee not to allocate memory
# in +pack+. If the capacity of <i>aBufferString</i> is not enough,
# +pack+ allocates memory.