summaryrefslogtreecommitdiff
path: root/doc/string/swapcase.rdoc
blob: 916e711b7ec7b2897218bd6923b8819e71cb2338 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
Returns a string containing the characters in +self+, with cases reversed:

- Each uppercase character is downcased.
- Each lowercase character is upcased.

Examples:

  'Hello'.swapcase        # => "hELLO"
  'Straße'.swapcase       # => "sTRASSE"
  'Привет'.swapcase       # => "пРИВЕТ"
  'RubyGems.org'.swapcase # => "rUBYgEMS.ORG"

The sizes of +self+ and the upcased result may differ:

  s = 'Straße'
  s.size          # => 6
  s.swapcase      # => "sTRASSE"
  s.swapcase.size # => 7

Some characters (and some character sets) do not have upcase and downcase versions;
see {Case Mapping}[rdoc-ref:case_mapping.rdoc]:

  s = '1, 2, 3, ...'
  s.swapcase == s # => true
  s = 'こんにちは'
  s.swapcase == s # => true

The casing is affected by the given +mapping+,
which may be +:ascii+, +:fold+, or +:turkic+;
see {Case Mappings}[rdoc-ref:case_mapping.rdoc@Case+Mappings].

Related: see {Converting to New String}[rdoc-ref:String@Converting+to+New+String].