Module Iconv::Failure
In: ext/iconv/iconv.c

Base attributes for Iconv exceptions.

Methods

failed   inspect   new   success  

Public Class methods

Iconv.new(to, from)

Creates new code converter from a coding-system designated with from to another one designated with to.

Parameters

to:encoding name for destination
from:encoding name for source

Exceptions

TypeError:if to or from aren‘t String
InvalidEncoding:if designated converter couldn‘t find out
SystemCallError:if iconv_open(3) fails

Public Instance methods

failed

Returns substring of the original string passed to Iconv that starts at the character caused the exception.

inspect

Returns inspected string like as: #<class: success, failed>

success

Returns string(s) translated successfully until the exception occurred.

  • In the case of failure occurred within Iconv.iconv, returned value is an array of strings translated successfully preceding failure and the last element is string on the way.

[Validate]

ruby-doc.org is a service of James Britt and Neurogami, a Ruby application development company in Phoenix, AZ.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.