Struct rutie::Encoding

pub struct Encoding { /* fields omitted */ }

Methods

impl Encoding

pub fn utf8() -> Self

Creates a UTF-8 instance of Encoding.

Examples

use rutie::{Encoding, VM};

Encoding::utf8();

Ruby:

Encoding::UTF_8

pub fn us_ascii() -> Self

Creates a US-ASCII instance of Encoding.

Examples

use rutie::{Encoding, VM};

Encoding::us_ascii();

Ruby:

Encoding::US_ASCII

pub fn default_external() -> Self

Creates a new instance of Encoding from the default external encoding.

Examples

use rutie::{Encoding, VM};

Encoding::default_external();

Ruby:

Encoding.default_external

pub fn default_internal() -> Result<Self, NilClass>

Creates an instance of Ok(Encoding) from the default internal encoding if there is one, otherwise it returns Err(NilClass).

Examples

use rutie::{Encoding, VM};

Encoding::default_internal();

Ruby:

Encoding.default_internal

pub fn name(&self) -> String

Returns encoding name.

Examples

use rutie::{RString, Encoding, VM};

let enc = Encoding::utf8();

assert_eq!(enc.name(), "UTF-8")

Ruby:

enc = Encoding::UTF_8

enc.name == "UTF-8"

pub fn find(s: &str) -> Result<Encoding, AnyException>

Find an Ok(Encoding) for given string name or return an Err(AnyException).

Examples

use rutie::{VM, Encoding};

let encoding = Encoding::find("UTF-8");

match encoding {
    Ok(enc) => assert_eq!(enc.name(), "UTF-8"),
    Err(_) => unreachable!()
}

Ruby:

encoding = Encoding.find("UTF-8")

encoding.name == "UTF-8"

The following is an example where a Ruby exception object of ArgumentError is returned.

use rutie::{VM, Encoding, Exception};

let encoding = Encoding::find("UTF8");

match encoding {
    Ok(_) => unreachable!(),
    Err(e) => assert_eq!(e.message(), "unknown encoding name - UTF8")
}

pub fn is_compatible(
    obj1: &impl Object,
    obj2: &impl Object
) -> Result<Self, NilClass>

Returns an instance of Ok(Encoding) if the objects are compatible encodings, otherwise it returns Err(NilClass).

Examples

use rutie::{Encoding, VM, RString, NilClass};

let utf8 = RString::new_utf8("asdf");
let us_ascii= RString::new_usascii_unchecked("qwerty");

let result = Encoding::is_compatible(&utf8, &us_ascii);

assert!(result.is_ok());

let result = Encoding::is_compatible(&utf8, &NilClass::new());

assert!(result.is_err());

Trait Implementations

impl Object for Encoding

fn value(&self) -> Value

Returns internal value of current object.

fn class(&self) -> Class

Returns a class of current object.

fn singleton_class(&self) -> Class

Returns a singleton class of current object.

fn get_data<'a, T>(&'a self, wrapper: &'a dyn DataTypeWrapper<T>) -> &T

Gets an immutable reference to the Rust structure which is wrapped into a Ruby object.

fn get_data_mut<'a, T>(
    &'a mut self,
    wrapper: &'a dyn DataTypeWrapper<T>
) -> &mut T

Gets a mutable reference to the Rust structure which is wrapped into a Ruby object.

fn define<F: Fn(&mut Self)>(&mut self, f: F) -> &Self

Wraps calls to the object.

fn define_method<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

Defines an instance method for the given class or object.

fn define_private_method<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

Defines a private instance method for the given class or object.

fn define_singleton_method<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

Defines a class method for given class or singleton method for object.

fn def<I: Object, O: Object>(&mut self, name: &str, callback: Callback<I, O>)

An alias for define_method (similar to Ruby syntax def some_method).

fn def_private<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

An alias for define_private_method (similar to Ruby syntax private def some_method).

fn def_self<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

An alias for define_singleton_method (similar to Ruby def self.some_method).

unsafe fn send(&self, method: &str, arguments: &[AnyObject]) -> AnyObject

Calls a given method on an object similarly to Ruby Object#send method

fn equals<T: Object>(&self, other: &T) -> bool

Alias for Ruby's ==

fn case_equals<T: Object>(&self, other: &T) -> bool

Alias for Ruby's ===

fn is_eql<T: Object>(&self, other: &T) -> bool

Alias for Ruby's eql?

fn is_equal<T: Object>(&self, other: &T) -> bool

Alias for Ruby's equal?

fn respond_to(&self, method: &str) -> bool

Checks whether the object responds to given method

fn protect_send(
    &self,
    method: &str,
    arguments: &[AnyObject]
) -> Result<AnyObject, AnyException>

protect_send returns Result<AnyObject, AnyObject>

fn protect_public_send(
    &self,
    method: &str,
    arguments: &[AnyObject]
) -> Result<AnyObject, AnyException>

protect_public_send returns Result<AnyObject, AnyObject>

fn is_nil(&self) -> bool

Checks whether the object is nil

fn to_any_object(&self) -> AnyObject

Converts struct to AnyObject

fn instance_variable_get(&self, variable: &str) -> AnyObject

Gets an instance variable of object

fn instance_variable_set<T: Object>(
    &mut self,
    variable: &str,
    value: T
) -> AnyObject

Sets an instance variable for object

fn is_frozen(&self) -> bool

Returns the freeze status of the object.

fn freeze(&mut self) -> Self

Prevents further modifications to the object.

unsafe fn to<T: Object>(&self) -> T

Unsafely casts current object to the specified Ruby type

fn try_convert_to<T: VerifiedObject>(&self) -> Result<T, AnyException>

Safely casts current object to the specified Ruby type

fn ty(&self) -> ValueType

Determines the value type of the object

impl VerifiedObject for Encoding

fn is_correct_type<T: Object>(object: &T) -> bool

fn error_message() -> &'static str

impl Default for Encoding

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Encoding> for Encoding

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl From<Value> for Encoding

fn from(value: Value) -> Self

Performs the conversion.

impl Into<Value> for Encoding

fn into(self) -> Value

Performs the conversion.

impl Into<AnyObject> for Encoding

fn into(self) -> AnyObject

Performs the conversion.

impl Debug for Encoding

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.