mirror/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2026-01-26 20:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] Tweaks for String#unpack

Browse Source
This commit is contained in:
BurdetteLamar 2025-11-16 20:40:43 +00:00 committed by Peter Zhu
parent 00521434a4
commit 43e26d02df
Notes: git 2025-11-16 21:26:38 +00:00 
Merged: https://github.com/ruby/ruby/pull/15210
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
pack.rb
View File

@ -10,16 +10,18 @@ class Array
end
class String
# call-seq:
# unpack(template, offset: 0, &block) -> array
# call-seq:
# unpack(template, offset: 0) {|o| .... } -> object
# unpack(template, offset: 0) -> array
#
# Extracts data from +self+.
# Extracts data from +self+ to form new objects;
# see {Packed Data}[rdoc-ref:packed_data.rdoc].
#
# If +block+ is not given, forming objects that become the elements
# of a new array, and returns that array. Otherwise, yields each
# object.
# With a block given, calls the block with each unpacked object.
#
# See {Packed Data}[rdoc-ref:packed_data.rdoc].
# With no block given, returns an array containing the unpacked objects.
#
# Related: see {Converting to Non-String}[rdoc-ref:String@Converting+to+Non--5CString].
def unpack(fmt, offset: 0)
Primitive.attr! :use_block
Primitive.pack_unpack(fmt, offset)