From: "noteflakes (Sharon Rosner) via ruby-core" <ruby-core@...>
Date: 2023-07-04T04:47:04+00:00
Subject: [ruby-core:114081] [Ruby master Bug#19753] IO::Buffer#get_string can't handle negative offset

Issue #19753 has been updated by noteflakes (Sharon Rosner).


nobu (Nobuyoshi Nakada) wrote in #note-3:
> > irb(main):003:0> b.get_string(-1000)
> > => "abc"
> 
> I think this should raise an `ArgumentError`.
> 
> > ```ruby
> > irb(main):003:0> b.get_string(-1000, 2)
> > => "ab"
> > ```
> 
> At least, it should not be `"ab"`.

Well now that I look at `String#[]` and `Array#[]` they return `nil` when `offset < -size`:

```ruby
irb(main):001:0> s = 'abc'
=> "abc"
irb(main):002:0> s[-3]
=> "a"
irb(main):003:0> s[-4]
=> nil
irb(main):004:0> a = [1,2,3]
=> [1, 2, 3]
irb(main):005:0> a[-4]
=> nil
irb(main):006:0> a[-4, 2]
=> nil
```

Would a similar behaviour be acceptable for `IO::Buffer`?

----------------------------------------
Bug #19753: IO::Buffer#get_string can't handle negative offset
https://bugs.ruby-lang.org/issues/19753#change-103752

* Author: noteflakes (Sharon Rosner)
* Status: Assigned
* Priority: Normal
* Assignee: ioquatix (Samuel Williams)
* ruby -v: 3.2
* Backport: 3.0: DONTNEED, 3.1: REQUIRED, 3.2: REQUIRED
----------------------------------------
```ruby
irb(main):001:0> b = IO::Buffer.for('abc')
=> 
#<IO::Buffer 0x00007f858f5450c0+3 EXTERNAL READONLY SLICE>
...
irb(main):002:0> b.get_string(-1)
=> "\x00abc"
irb(main):003:0> b.get_string(-1000, 3)
(irb):3:in `get_string': Specified offset+length exceeds data size! (ArgumentError)
	from (irb):3:in `<main>'
	from /home/sharon/.rbenv/versions/3.2.0/lib/ruby/gems/3.2.0/gems/irb-1.7.1/exe/irb:9:in `<top (required)>'
	from /home/sharon/.rbenv/versions/3.2.0/bin/irb:25:in `load'
	from /home/sharon/.rbenv/versions/3.2.0/bin/irb:25:in `<main>'
```

Using a negative offset returns garbage in the string but it also might segfault:

```ruby
irb(main):003:0> b = IO::Buffer.map(File.open('sgt-nodes.sql', 'r+'))
=> #<IO::Buffer 0x00007f189de14000+2008858 EXTERNAL MAPPED SHARED>
irb(main):004:0> b.get_string(-1000)
(irb):4: [BUG] Segmentation fault at 0x00007f189de13c18
ruby 3.2.0 (2022-12-25 revision a528908271) [x86_64-linux]

-- Control frame information -----------------------------------------------
c:0021 p:---- s:0109 e:000108 CFUNC  :get_string
...
```

## Expected behaviour

I think it might be nice to have `#get_string` behave like other methods taking an offset, like `String#[]`, so a negative offset means counting backwards from the end of the buffer. For example:

```ruby
irb(main):001:0> b = IO::Buffer.for('abc')
=> 
#<IO::Buffer 0x00007f858f5450c0+3 EXTERNAL READONLY SLICE>
...
irb(main):002:0> b.get_string(-1)
=> "c"
irb(main):003:0> b.get_string(-2)
=> "bc"
irb(main):003:0> b.get_string(-1000)
=> "abc"
irb(main):003:0> b.get_string(-1000, 2)
=> "ab"
```




-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/postorius/lists/ruby-core.ml.ruby-lang.org/