Struct rutie::RString

pub struct RString { /* fields omitted */ }

String

Methods

impl RString

pub fn new(string: &str) -> Self

Creates a new instance of Ruby String containing given string.

Examples

use rutie::{RString, VM};

let string = RString::new("Hello, World!");

assert_eq!(string.to_str(), "Hello, World!");

Ruby:

str = 'Hello, World!'

str == 'Hello, World!'

pub fn new_utf8(string: &str) -> Self

Creates a new instance of Ruby String, with UTF8 encoding, containing given string.

Examples

use rutie::{RString, VM};

let string = RString::new_utf8("Hello, World!");

assert_eq!(string.to_string(), "Hello, World!".to_string());

Ruby:

str = 'Hello, World!'

str == 'Hello, World!'

pub fn to_string(&self) -> String

Retrieves underlying Rust String from Ruby String object.

Examples

use rutie::{RString, VM};

let string = RString::new("Hello, World!");

assert_eq!(string.to_string(), "Hello, World!".to_string());

Ruby:

str = 'Hello, World!'

str == 'Hello, World!'

pub fn to_string_unchecked(&self) -> String

Retrieves underlying Rust String from Ruby String object.

Unlike to_string() it does not perform any checks for internal null-bytes.

This function may be used to safely get binary data from Ruby.

Examples

use rutie::{RString, VM};

let string = RString::new("Hello,\0World!");

assert_eq!(string.to_string_unchecked(), "Hello,\0World!".to_string());

Ruby:

str = 'Hello,\0World!'

str == 'Hello,\0World!'

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn to_vec_u8_unchecked(&self) -> Vec<u8>

Retrieves Vec<u8> from Ruby String object.

Unlike to_string() it does not perform any checks for internal null-bytes.

This function may be used to safely get binary data from Ruby.

Examples

use rutie::{RString, VM};

let string = RString::new("Hello,\0World!");

assert_eq!(string.to_vec_u8_unchecked(), (b"Hello,\0World!").to_vec());

pub fn to_str(&self) -> &str

Retrieves underlying &str from Ruby String object.

Examples

use rutie::{RString, VM};

let string = RString::new("Hello, World!");

assert_eq!(string.to_str(), "Hello, World!");

Ruby:

str = 'Hello, World!'

str == 'Hello, World!'

pub fn to_str_unchecked(&self) -> &str

Retrieves underlying &str from Ruby String object.

Unlike to_str() it does not perform any checks for internal null-bytes.

This function may be used to safely get binary data from Ruby.

Examples

use rutie::{RString, VM};

let string = RString::new("Hello,\0World!");

assert_eq!(string.to_str_unchecked(), "Hello,\0World!");

Ruby:

str = 'Hello,\0World!'

str == 'Hello,\0World!'

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

pub fn to_bytes_unchecked(&self) -> &[u8]

Retrieves underlying &[u8] from Ruby String object.

Unlike to_str() it does not perform any checks for internal null-bytes.

This function may be used to safely get binary data from Ruby.

Examples

use rutie::{RString, VM};

let string = RString::new("Hello,\0World!");

assert_eq!(string.to_bytes_unchecked(), b"Hello,\0World!");

pub fn bytesize(&self) -> i64

Returns the length of the string in bytes

Examples

use rutie::{RString, VM};

let string = RString::new("Hello, World!");
let utf8_string = RString::new("⓯");

assert_eq!(string.bytesize(), 13);
assert_eq!(utf8_string.bytesize(), 3);

Ruby:

string = 'Hello, World!'
utf8_string = '⓯'

string.bytesize == 13
utf8_string.bytesize == 3

pub fn concat(&mut self, string: &str)

Appends a given string slice onto the end of this String.

Examples

use rutie::{RString, VM};

let mut string = RString::new("Hello, ");
string.concat("World!");

assert_eq!(string.to_string(), "Hello, World!".to_string());

Ruby:

str = 'Hello, '
str << 'World!'

str == 'Hello, World!'

Trait Implementations

impl Debug for RString

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

Formats the value using the given formatter.

impl PartialEq for RString

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

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

fn ne(&self, other: &RString) -> bool

This method tests for !=.

impl From<Value> for RString

fn from(value: Value) -> Self

Performs the conversion.

impl From<String> for RString

fn from(string: String) -> Self

Performs the conversion.

impl Object for RString

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.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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).

fn send(&self, method: &str, arguments: Option<&[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: String,     arguments: Option<&[AnyObject]> ) -> Result<AnyObject, AnyException>

protect_send returns Result<AnyObject, AnyObject>

fn protect_public_send(     &self,     method: String,     arguments: Option<&[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 RString

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

fn error_message() -> &'static str