to_s vs. to_str (and to_i/to_a/to_h vs. to_int/to_ary/to_hash) in Ruby

by

Note first that all of this applies to each pair of “short” (e.g. to_s/to_i/to_a/to_h) vs. “long” (e.g. to_str/to_int/to_ary/to_hash) coercion methods in Ruby (for their respective types) as they all have the same semantics.

They have different meanings. You should not implement to_str unless your object acts like a string, rather than just being representable by a string. The only core class that implements to_str is String itself.

From Programming Ruby (quoted from this blog post, which is worth reading all of):

[to_i and to_s] are not particularly strict: if an object has some kind of decent representation as a string, for example, it will probably have a to_s method… [to_int and to_str] are strict conversion functions: you implement them only if [your] object can naturally be used every place a string or an integer could be used.

Older Ruby documentation from the Pickaxe has this to say:

Unlike to_s, which is supported by almost all classes, to_str is normally implemented only by those classes that act like strings.

For example, in addition to Integer, both Float & Numeric implement to_int (to_i‘s equivalent of to_str) because both of them can readily substituted for an Integer (they are all actually numbers). Unless your class has a similarly tight relationship with String, you should not implement to_str.

More Related Contents:

  1. Very Basic Ruby puts and gets
  2. Why are exclamation marks used in Ruby methods?
  3. Double vs single quotes
  4. Ruby: String Comparison Issues
  5. Why use symbols as hash keys in Ruby?
  6. What does %w(array) mean?
  7. Executing code for every method call in a Ruby module
  8. Ruby function to remove all white spaces?
  9. What’s the difference between a string and a symbol in Ruby?
  10. How to check whether a string contains a substring in Ruby
  11. Why is the shovel operator (
  12. What is the easiest way to remove the first character from a string?
  13. Ruby 1.9 Array.to_s behaves differently?
  14. Extract a substring from a string in Ruby using a regular expression
  15. Which style of Ruby string quoting do you favour?
  16. String interpolation in Ruby doesn’t work?
  17. Measure the distance between two strings with Ruby?
  18. Read binary file as string in Ruby
  19. Passing a method as a parameter in Ruby
  20. Why do two strings separated by space concatenate in Ruby?
  21. Convert unicode codepoint to string character in Ruby
  22. Invalid function in ruby
  23. Ruby: Merging variables in to a string
  24. Split string by multiple delimiters
  25. What is the use case for Ruby’s %q / %Q quoting methods?
  26. How do methods use hash arguments in Ruby?
  27. Overriding method by another defined in module
  28. What is the opposite of string.next?
  29. Test if variable matches any of several strings w/o long if-elsif chain, or case-when
  30. What is the best way to split a string to get all the substrings by Ruby?

Leave a Comment