Struct rutie::RString [−][src]
pub struct RString { /* fields omitted */ }
String
Methods
impl RString
[src]
impl RString
pub fn new(string: &str) -> Self
[src]
pub fn new(string: &str) -> Self
: please use new_usascii_unchecked
or new_utf8
instead
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
[src]
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 new_usascii_unchecked(string: &str) -> Self
[src]
pub fn new_usascii_unchecked(string: &str) -> Self
Creates a new instance of Ruby String
containing given string
.
Examples
use rutie::{RString, VM}; let string = RString::new_usascii_unchecked("Hello, World!"); assert_eq!(string.to_str(), "Hello, World!");
Ruby:
str = 'Hello, World!'
str == 'Hello, World!'
pub fn from_bytes(bytes: &[u8], enc: &Encoding) -> Self
[src]
pub fn from_bytes(bytes: &[u8], enc: &Encoding) -> Self
Creates a new instance of Ruby String
from given byte
sequence with given Encoding
.
Examples
use rutie::{RString, Encoding, EncodingSupport, VM}; let bytes = [197, 130, 97, 197, 130]; let enc = Encoding::find("UTF-8").unwrap(); let string = RString::from_bytes(&bytes, &enc); assert_eq!(string.to_str(), "łał"); VM::require("enc/encdb"); VM::require("enc/trans/transdb"); let result = string.encode(Encoding::find("UTF-16").unwrap(), None); assert_eq!(result.to_bytes_unchecked(), [254, 255, 1, 66, 0, 97, 1, 66])
pub fn to_string(&self) -> String
[src]
pub fn to_string(&self) -> String
Retrieves underlying Rust String
from Ruby String
object.
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_unchecked(&self) -> String
[src]
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_utf8("Hello,\0World!"); assert_eq!(string.to_string_unchecked(), "Hello,\0World!".to_string());
Ruby:
str = 'Hello,\0World!'
str == 'Hello,\0World!'
pub fn to_vec_u8_unchecked(&self) -> Vec<u8>
[src]
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_utf8("Hello,\0World!"); assert_eq!(string.to_vec_u8_unchecked(), (b"Hello,\0World!").to_vec());
pub fn to_str(&self) -> &str
[src]
pub fn to_str(&self) -> &str
Retrieves underlying &str
from Ruby String
object.
Examples
use rutie::{RString, VM}; let string = RString::new_utf8("Hello, World!"); assert_eq!(string.to_str(), "Hello, World!");
Ruby:
str = 'Hello, World!'
str == 'Hello, World!'
pub fn to_str_unchecked(&self) -> &str
[src]
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_utf8("Hello,\0World!"); assert_eq!(string.to_str_unchecked(), "Hello,\0World!");
Ruby:
str = 'Hello,\0World!'
str == 'Hello,\0World!'
pub fn to_bytes_unchecked(&self) -> &[u8]
[src]
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_utf8("Hello,\0World!"); assert_eq!(string.to_bytes_unchecked(), b"Hello,\0World!");
pub fn bytesize(&self) -> i64
[src]
pub fn bytesize(&self) -> i64
Returns the length of the string in bytes
Examples
use rutie::{RString, VM}; let string = RString::new_utf8("Hello, World!"); let utf8_string = RString::new_utf8("⓯"); 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 count_chars(&self) -> i64
[src]
pub fn count_chars(&self) -> i64
Returns the number of characters in the string
Examples
use rutie::{RString, VM}; let string = RString::new_utf8("Hello, World!"); let utf8_string = RString::new_utf8("⓯"); assert_eq!(string.count_chars(), 13); assert_eq!(utf8_string.count_chars(), 1);
Ruby:
string = 'Hello, World!'
utf8_string = '⓯'
string.length == 13
utf8_string.length == 1
pub fn concat(&mut self, string: &str)
[src]
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_utf8("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
[src]
impl Debug for RString
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl PartialEq for RString
[src]
impl PartialEq for RString
fn eq(&self, other: &RString) -> bool
[src]
fn eq(&self, other: &RString) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &RString) -> bool
[src]
fn ne(&self, other: &RString) -> bool
This method tests for !=
.
impl EncodingSupport for RString
[src]
impl EncodingSupport for RString
fn encoding(&self) -> Encoding
[src]
fn encoding(&self) -> Encoding
Get the strings Encoding
.
Examples
use rutie::{RString, VM, EncodingSupport}; let string = RString::new_utf8("Hello"); string.encoding();
Ruby:
string = "Hello"
string.encoding()
fn force_encoding(&mut self, enc: Encoding) -> Result<Self, AnyException>
[src]
fn force_encoding(&mut self, enc: Encoding) -> Result<Self, AnyException>
Changes the encoding to encoding and returns Result<Self, AnyException>
.
Examples
use rutie::{RString, VM, EncodingSupport, Encoding}; let mut string = RString::new_utf8("Hello"); string.force_encoding(Encoding::us_ascii()); assert_eq!(string.encoding().name(), "US-ASCII");
Ruby:
string = "Hello"
string.force_encoding(Encoding::US_ASCII)
string.encoding.name == "US-ASCII"
fn encode(&self, enc: Encoding, opts: Option<Hash>) -> Self
[src]
fn encode(&self, enc: Encoding, opts: Option<Hash>) -> Self
Transcodes to encoding and returns Self
.
Examples
use rutie::{RString, VM, EncodingSupport, Encoding}; let mut string = RString::new_utf8("Hello"); let result = string.encode(Encoding::us_ascii(), None); assert_eq!(result.encoding().name(), "US-ASCII");
Ruby:
string = "Hello"
result = string.encode(Encoding::US_ASCII)
result.encoding.name == "US-ASCII"
fn is_valid_encoding(&self) -> bool
[src]
fn is_valid_encoding(&self) -> bool
Transcodes to encoding and returns Self
.
Examples
use rutie::{RString, VM, EncodingSupport, Encoding, Object}; let mut string = RString::new_utf8("Hello"); assert!(string.is_valid_encoding(), "not valid encoding!"); VM::require("enc/encdb"); VM::require("enc/trans/transdb"); let result = VM::eval("'Hello'.force_encoding('UTF-32')").unwrap(). try_convert_to::<RString>().unwrap(); assert!(!result.is_valid_encoding(), "is valid encoding!");
Ruby:
string = "Hello"
string.valid_encoding? == true
result = string.encode(Encoding::UTF_32)
result.valid_encoding? == false
impl From<Value> for RString
[src]
impl From<Value> for RString
impl From<String> for RString
[src]
impl From<String> for RString
impl TryConvert<AnyObject> for RString
[src]
impl TryConvert<AnyObject> for RString
Implicit or nil
conversion
Examples
use rutie::{RString, Fixnum, VM, TryConvert, NilClass, Object}; let four = Fixnum::new(4); let result = RString::try_convert(four.to_any_object()); assert_eq!(result, Err(NilClass::new())); let five = RString::new_utf8("5"); let result2 = RString::try_convert(five.to_any_object()); if let Ok(r) = result2 { assert_eq!(r.to_str(), "5") } else { unreachable!() }
Ruby:
four = 4
result = String.try_convert(four)
result == nil
five = "5"
result = String.try_convert(five)
result == "5"
type Nil = NilClass
The type returned in the event of a conversion error.
fn try_convert(obj: AnyObject) -> Result<Self, NilClass>
[src]
fn try_convert(obj: AnyObject) -> Result<Self, NilClass>
Performs the conversion.
impl Object for RString
[src]
impl Object for RString
fn value(&self) -> Value
[src]
fn value(&self) -> Value
Returns internal value
of current object. Read more
fn class(&self) -> Class
[src]
fn class(&self) -> Class
Returns a class of current object. Read more
fn singleton_class(&self) -> Class
[src]
fn singleton_class(&self) -> Class
Returns a singleton class of current object. Read more
ⓘImportant traits for &'a mut Rfn get_data<'a, T>(&'a self, wrapper: &'a DataTypeWrapper<T>) -> &T
[src]
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. Read more
ⓘImportant traits for &'a mut Rfn get_data_mut<'a, T>(&'a mut self, wrapper: &'a DataTypeWrapper<T>) -> &mut T
[src]
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 Rfn define<F: Fn(&mut Self)>(&mut self, f: F) -> &Self
[src]
fn define<F: Fn(&mut Self)>(&mut self, f: F) -> &Self
Wraps calls to the object. Read more
fn define_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
[src]
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. Read more
fn define_private_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
[src]
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. Read more
fn define_singleton_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
[src]
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. Read more
fn def<I: Object, O: Object>(&mut self, name: &str, callback: Callback<I, O>)
[src]
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>
)
[src]
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>
)
[src]
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
[src]
fn send(&self, method: &str, arguments: Option<&[AnyObject]>) -> AnyObject
Calls a given method on an object similarly to Ruby Object#send
method Read more
fn equals<T: Object>(&self, other: &T) -> bool
[src]
fn equals<T: Object>(&self, other: &T) -> bool
Alias for Ruby's ==
Read more
fn case_equals<T: Object>(&self, other: &T) -> bool
[src]
fn case_equals<T: Object>(&self, other: &T) -> bool
Alias for Ruby's ===
Read more
fn is_eql<T: Object>(&self, other: &T) -> bool
[src]
fn is_eql<T: Object>(&self, other: &T) -> bool
Alias for Ruby's eql?
Read more
fn is_equal<T: Object>(&self, other: &T) -> bool
[src]
fn is_equal<T: Object>(&self, other: &T) -> bool
Alias for Ruby's equal?
Read more
fn respond_to(&self, method: &str) -> bool
[src]
fn respond_to(&self, method: &str) -> bool
Checks whether the object responds to given method Read more
fn protect_send(
&self,
method: String,
arguments: Option<&[AnyObject]>
) -> Result<AnyObject, AnyException>
[src]
fn protect_send(
&self,
method: String,
arguments: Option<&[AnyObject]>
) -> Result<AnyObject, AnyException>
protect_send
returns Result<AnyObject, AnyObject> Read more
fn protect_public_send(
&self,
method: String,
arguments: Option<&[AnyObject]>
) -> Result<AnyObject, AnyException>
[src]
fn protect_public_send(
&self,
method: String,
arguments: Option<&[AnyObject]>
) -> Result<AnyObject, AnyException>
protect_public_send
returns Result<AnyObject, AnyObject> Read more
fn is_nil(&self) -> bool
[src]
fn is_nil(&self) -> bool
Checks whether the object is nil
Read more
fn to_any_object(&self) -> AnyObject
[src]
fn to_any_object(&self) -> AnyObject
Converts struct to AnyObject
Read more
fn instance_variable_get(&self, variable: &str) -> AnyObject
[src]
fn instance_variable_get(&self, variable: &str) -> AnyObject
Gets an instance variable of object Read more
fn instance_variable_set<T: Object>(
&mut self,
variable: &str,
value: T
) -> AnyObject
[src]
fn instance_variable_set<T: Object>(
&mut self,
variable: &str,
value: T
) -> AnyObject
Sets an instance variable for object Read more
fn is_frozen(&self) -> bool
[src]
fn is_frozen(&self) -> bool
Returns the freeze status of the object. Read more
fn freeze(&mut self) -> Self
[src]
fn freeze(&mut self) -> Self
Prevents further modifications to the object. Read more
unsafe fn to<T: Object>(&self) -> T
[src]
unsafe fn to<T: Object>(&self) -> T
Unsafely casts current object to the specified Ruby type Read more
fn try_convert_to<T: VerifiedObject>(&self) -> Result<T, AnyException>
[src]
fn try_convert_to<T: VerifiedObject>(&self) -> Result<T, AnyException>
Safely casts current object to the specified Ruby type Read more
fn ty(&self) -> ValueType
[src]
fn ty(&self) -> ValueType
Determines the value type of the object Read more
impl VerifiedObject for RString
[src]
impl VerifiedObject for RString
fn is_correct_type<T: Object>(object: &T) -> bool
[src]
fn is_correct_type<T: Object>(object: &T) -> bool
fn error_message() -> &'static str
[src]
fn error_message() -> &'static str