String#getbyte

(::int index) -> ::Integer?

getbyte(index) → integer or nil

VALUE
rb_str_getbyte(VALUE str, VALUE index)
{
    long pos = NUM2LONG(index);

    if (pos < 0)
        pos += RSTRING_LEN(str);
    if (pos < 0 ||  RSTRING_LEN(str) <= pos)
        return Qnil;

    return INT2FIX((unsigned char)RSTRING_PTR(str)[pos]);
}

Returns the byte at zero-based index as an integer, or nil if index is out of range:

Example

s = 'abcde'   # => "abcde"
s.getbyte(0)  # => 97
s.getbyte(-1) # => 101
s.getbyte(5)  # => nil

Related: String#setbyte.

See also #force_encoding #grapheme_clusters #eql? #gsub also in 4.1 · 4.0 · 3.3 · 3.2 · 3.1 · 3.0

‹ prev#force_encoding next ›#grapheme_clusters