instance method

String#strip

() -> ::String

strip(*selectors) → new_string

static VALUE
rb_str_strip(int argc, VALUE *argv, VALUE str)
{
    char *start;
    long olen, loffset, roffset;
    rb_encoding *enc = STR_ENC_GET(str);

    RSTRING_GETMEM(str, start, olen);

    if (argc > 0) {
        char table[TR_TABLE_SIZE];
        VALUE del = 0, nodel = 0;

        tr_setup_table_multi(table, &del, &nodel, str, argc, argv);
        loffset = lstrip_offset_table(str, start, start+olen, enc, table, del, nodel);
        roffset = rstrip_offset_table(str, start+loffset, start+olen, enc, table, del, nodel);
    }
    else {
        loffset = lstrip_offset(str, start, start+olen, enc);
        roffset = rstrip_offset(str, start+loffset, start+olen, enc);
    }

    if (loffset <= 0 && roffset <= 0) return str_duplicate(rb_cString, str);
    return rb_str_subseq(str, loffset, olen-loffset-roffset);
}

Returns a copy of self with leading and trailing whitespace removed; see Whitespace in Strings:

Example

whitespace = "\x00\t\n\v\f\r "
s = whitespace + 'abc' + whitespace
# => "\u0000\t\n\v\f\r abc\u0000\t\n\v\f\r "
s.strip # => "abc"

If selectors are given, removes characters of selectors from both ends of self:

Example

s = "---abc+++"
s.strip("-+") # => "abc"
s.strip("+-") # => "abc"

selectors must be valid character selectors (see Character Selectors), and may use any of its valid forms, including negation, ranges, and escapes:

Example

"01234abc56789".strip("0-9") # "abc"
"01234abc56789".strip("0-9", "^4-6") # "4abc56"

Related: see Converting to New String.

Ruby version changes

4.0
- String#strip, strip!, lstrip, lstrip!, rstrip, and rstrip! are extended to accept *selectors arguments. [Feature #21552]
3.0
- The following methods now return or yield String instances instead of subclass instances when called on subclass instances: [Bug #10845]

See also #strip! #start_with? #squeeze! #sub also in 4.1 · 3.4 · 3.3 · 3.2 · 3.1 · 3.0

‹ prev#start_with? next ›#strip!