Module: Iconv::Failure

Included in:
BrokenLibrary, IllegalSequence, InvalidCharacter, InvalidEncoding, OutOfRange
Defined in:
iconv.c

Overview

Base attributes for Iconv exceptions.

Instance Method Summary collapse

Instance Method Details

#failed ⇒ Object

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




# File 'iconv.c'

/*
 * Document-method: failed
 * call-seq: failed
 *
 * Returns substring of the original string passed to Iconv that starts at the
 * character caused the exception. 
 */
static VALUE
iconv_failure_failed
    (self)
    VALUE self;
{
    return rb_attr_get(self, rb_failed);
}

#initialize ⇒ Object

#inspect ⇒ Object

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




# File 'iconv.c'

/*
 * Document-method: inspect
 * call-seq: inspect
 *
 * Returns inspected string like as: #<_class_: _success_, _failed_>
 */
static VALUE
iconv_failure_inspect
    (self)
    VALUE self;
{
    const char *cname = rb_class2name(CLASS_OF(self));
    VALUE success = rb_attr_get(self, rb_success);
    VALUE failed = rb_attr_get(self, rb_failed);
    VALUE str = rb_str_buf_cat2(rb_str_new2("#<"), cname);
    str = rb_str_buf_cat(str, ": ", 2);
    str = rb_str_buf_append(str, rb_inspect(success));
    str = rb_str_buf_cat(str, ", ", 2);
    str = rb_str_buf_append(str, rb_inspect(failed));
    return rb_str_buf_cat(str, ">", 1);
}

#success ⇒ Object

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.




# File 'iconv.c'

/*
 * Document-method: success
 * call-seq: 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.
 */
static VALUE
iconv_failure_success
    (self)
    VALUE self;
{
    return rb_attr_get(self, rb_success);
}