#[repr(C)]pub struct Array { /* private fields */ }
Expand description
Array
Implementations§
source§impl Array
impl Array
sourcepub fn with_capacity(capacity: usize) -> Self
pub fn with_capacity(capacity: usize) -> Self
Creates a new instance of empty Array
with reserved space for capacity
elements.
Examples
use rutie::{Array, Fixnum, VM};
let mut array = Array::with_capacity(2);
assert_eq!(array.length(), 0);
array.push(Fixnum::new(1));
array.push(Fixnum::new(2));
assert_eq!(array.length(), 2);
Ruby:
[]
sourcepub fn length(&self) -> usize
pub fn length(&self) -> usize
Retrieves the length of the array.
Examples
use rutie::{Array, Fixnum, VM};
let mut array = Array::new().push(Fixnum::new(1));
assert_eq!(array.length(), 1);
array.push(Fixnum::new(2));
assert_eq!(array.length(), 2);
Ruby:
array = [1]
array.length == 1
array << 2
array.length == 2
sourcepub fn at(&self, index: i64) -> AnyObject
pub fn at(&self, index: i64) -> AnyObject
Retrieves an AnyObject
from the element at index
position.
Examples
use rutie::{Array, Fixnum, Object, VM};
let array = Array::new().push(Fixnum::new(1));
assert_eq!(array.at(0).try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
Ruby:
array = [1]
array[0] == 1
sourcepub fn join(&self, separator: RString) -> RString
pub fn join(&self, separator: RString) -> RString
Joins all elements of Array
to Ruby String
.
Examples
use rutie::{Array, RString, VM};
let array = Array::new()
.push(RString::new_utf8("Hello"))
.push(RString::new_utf8("World!"));
let joined_string = array.join(RString::new_utf8(", "));
assert_eq!(joined_string.to_str(), "Hello, World!");
Ruby:
array = ['Hello', 'World!']
joined_string = array.join(', ')
joined_string == 'Hello, World!'
sourcepub fn push<T: Object>(&mut self, item: T) -> Self
pub fn push<T: Object>(&mut self, item: T) -> Self
Pushes an object to Array
.
Examples
use rutie::{Array, Fixnum, Object, VM};
let mut array = Array::new();
array.push(Fixnum::new(1));
assert_eq!(array.at(0).try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
Ruby:
array = []
array << 1
array[0] == 1
sourcepub fn store<T: Object>(&mut self, index: i64, item: T)
pub fn store<T: Object>(&mut self, index: i64, item: T)
Stores an object at index
position.
Examples
use rutie::{Array, Fixnum, Object, VM};
let mut array = Array::new().push(Fixnum::new(1));
array.store(0, Fixnum::new(2));
assert_eq!(array.at(0).try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
Ruby:
array = [1]
array[0] = 2
array[0] == 2
sourcepub fn pop(&mut self) -> AnyObject
pub fn pop(&mut self) -> AnyObject
Removes and returns the last element of the array.
Examples
use rutie::{Array, Fixnum, Object, VM};
let mut array = Array::new().push(Fixnum::new(1));
assert_eq!(array.pop().try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
Ruby:
array = [1]
array.pop == 1
sourcepub fn unshift<T: Object>(&mut self, item: T) -> Array
pub fn unshift<T: Object>(&mut self, item: T) -> Array
Inserts item
at the beginning of the array.
Examples
use rutie::{Array, Fixnum, Object, VM};
let mut array = Array::new().push(Fixnum::new(1));
array.unshift(Fixnum::new(2));
assert_eq!(array.at(0).try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
Ruby:
array = [1]
array.unshift(2)
array[0] == 2
sourcepub fn shift(&mut self) -> AnyObject
pub fn shift(&mut self) -> AnyObject
Removes the first item of the array and returns it.
Examples
use rutie::{Array, Fixnum, Object, VM};
let mut array = Array::new().push(Fixnum::new(1)).push(Fixnum::new(2));
let item = array.shift();
assert_eq!(item.try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
assert_eq!(array.at(0).try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
Ruby:
array = [1, 2]
item = array.shift
item == 1
array[0] == 2
sourcepub fn dup(&self) -> Array
pub fn dup(&self) -> Array
Creates a copy of the array.
Examples
use rutie::{Array, Fixnum, Object, VM};
let array = Array::new().push(Fixnum::new(1));
let copy = array.dup();
assert_eq!(array.at(0), copy.at(0));
Ruby:
array = [1]
copy = array.dup
array[0] == copy[0]
sourcepub fn to_s(&self) -> RString
pub fn to_s(&self) -> RString
Creates a string representation of the array.
Examples
use rutie::{Array, Fixnum, VM};
let array = Array::new().push(Fixnum::new(1)).push(Fixnum::new(2));
assert_eq!(array.to_s().to_str(), "[1, 2]");
Ruby:
array = [1, 2]
array.to_s == "[1, 2]"
sourcepub fn reverse(&self) -> Array
pub fn reverse(&self) -> Array
Returns a new array containing array’s elements in reverse order.
Examples
use rutie::{Array, Fixnum, Object, VM};
let mut array = Array::new().push(Fixnum::new(1)).push(Fixnum::new(2));
let reversed_array = array.reverse();
assert_eq!(reversed_array.at(0).try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
assert_eq!(reversed_array.at(1).try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
Ruby:
array = [1, 2]
reversed_array = array.reverse
reversed_array[0] == 2
reversed_array[1] == 1
sourcepub fn reverse_bang(&mut self) -> Array
pub fn reverse_bang(&mut self) -> Array
Reverses self
in place.
Examples
use rutie::{Array, Fixnum, Object, VM};
let mut array = Array::new().push(Fixnum::new(1)).push(Fixnum::new(2));
array.reverse_bang();
assert_eq!(array.at(0).try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
assert_eq!(array.at(1).try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
Ruby:
array = [1, 2]
array.reverse!
array[0] == 2
array[1] == 1
sourcepub fn concat(&mut self, other: &Array) -> Array
pub fn concat(&mut self, other: &Array) -> Array
Appends the elements of other
array to self
.
Examples
use rutie::{Array, Fixnum, Object, VM};
let mut array = Array::new().push(Fixnum::new(1));
let other = Array::new().push(Fixnum::new(2));
array.concat(&other);
assert_eq!(array.at(0).try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
assert_eq!(array.at(1).try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
Ruby:
array = [1]
other = [2]
array.concat(other)
array[0] == 1
array[1] == 2
sourcepub fn sort(&self) -> Array
pub fn sort(&self) -> Array
Returns a new array created by sorting self
.
Examples
use rutie::{Array, Fixnum, Object, VM};
let array = Array::new().push(Fixnum::new(2)).push(Fixnum::new(1));
let sorted_array = array.sort();
assert_eq!(sorted_array.at(0).try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
assert_eq!(sorted_array.at(1).try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
Ruby:
array = [2, 1]
sorted_array = array.sort
sorted_array[0] == 1
sorted_array[1] == 2
sourcepub fn sort_bang(&mut self) -> Array
pub fn sort_bang(&mut self) -> Array
Sorts the array in place.
Examples
use rutie::{Array, Fixnum, Object, VM};
let mut array = Array::new().push(Fixnum::new(2)).push(Fixnum::new(1));
array.sort_bang();
assert_eq!(array.at(0).try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
assert_eq!(array.at(1).try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
Ruby:
array = [2, 1]
array.sort!
array[0] == 1
array[1] == 2
sourcepub fn to_enum(&self) -> Enumerator
pub fn to_enum(&self) -> Enumerator
Returns an Enumerator
instance
Examples
use rutie::{Array, Fixnum, Object, VM, VerifiedObject, Enumerator};
let enumerator = Array::new().push(Fixnum::new(2)).push(Fixnum::new(1)).to_enum();
assert!(Enumerator::is_correct_type(&enumerator), "incorrect type!");
Ruby:
enumerator = [2, 1].to_enum
Enumerator === enumerator
Trait Implementations§
source§impl FromIterator<AnyObject> for Array
impl FromIterator<AnyObject> for Array
Converts an iterator into Array
.
Examples
use rutie::{Array, Fixnum, Object, VM};
let array: Array = (1..6)
.map(|num| num * 2)
.map(|num| Fixnum::new(num).to_any_object())
.collect();
assert_eq!(array.length(), 5);
for i in 0..5 {
let expected_number = (i + 1) * 2;
assert_eq!(array.at(i).try_convert_to::<Fixnum>().unwrap().to_i64(), expected_number);
}
source§impl IntoIterator for Array
impl IntoIterator for Array
Allows Arrays to be iterable in Rust.
Examples
use rutie::{Array, Fixnum, Object, VM};
let mut array = Array::new()
.push(Fixnum::new(1))
.push(Fixnum::new(2))
.push(Fixnum::new(3));
let mut sum: i64 = 0;
for item in array.into_iter() {
sum += item.try_convert_to::<Fixnum>().unwrap().to_i64();
}
assert_eq!(sum, 6);
source§impl Object for Array
impl Object for Array
source§fn singleton_class(&self) -> Class
fn singleton_class(&self) -> Class
source§fn get_data<'a, T>(&'a self, wrapper: &'a dyn DataTypeWrapper<T>) -> &T
fn get_data<'a, T>(&'a self, wrapper: &'a dyn DataTypeWrapper<T>) -> &T
source§fn get_data_mut<'a, T>(
&'a mut self,
wrapper: &'a dyn DataTypeWrapper<T>
) -> &mut T
fn get_data_mut<'a, T>( &'a mut self, wrapper: &'a dyn DataTypeWrapper<T> ) -> &mut T
source§fn define_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
fn define_method<I: Object, O: Object>( &mut self, name: &str, callback: Callback<I, O> )
source§fn define_private_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
fn define_private_method<I: Object, O: Object>( &mut self, name: &str, callback: Callback<I, O> )
source§fn define_singleton_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
fn define_singleton_method<I: Object, O: Object>( &mut self, name: &str, callback: Callback<I, O> )
source§fn def<I: Object, O: Object>(&mut self, name: &str, callback: Callback<I, O>)
fn def<I: Object, O: Object>(&mut self, name: &str, callback: Callback<I, O>)
define_method
(similar to Ruby syntax def some_method
).source§fn def_private<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
fn def_private<I: Object, O: Object>( &mut self, name: &str, callback: Callback<I, O> )
define_private_method
(similar to Ruby syntax private def some_method
).source§fn def_self<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
fn def_self<I: Object, O: Object>( &mut self, name: &str, callback: Callback<I, O> )
define_singleton_method
(similar to Ruby def self.some_method
).source§unsafe fn send(&self, method: &str, arguments: &[AnyObject]) -> AnyObject
unsafe fn send(&self, method: &str, arguments: &[AnyObject]) -> AnyObject
Object#send
method Read moresource§fn respond_to(&self, method: &str) -> bool
fn respond_to(&self, method: &str) -> bool
source§fn protect_send(
&self,
method: &str,
arguments: &[AnyObject]
) -> Result<AnyObject, AnyException>
fn protect_send( &self, method: &str, arguments: &[AnyObject] ) -> Result<AnyObject, AnyException>
protect_send
returns Result<AnyObject, AnyObject> Read moresource§fn protect_public_send(
&self,
method: &str,
arguments: &[AnyObject]
) -> Result<AnyObject, AnyException>
fn protect_public_send( &self, method: &str, arguments: &[AnyObject] ) -> Result<AnyObject, AnyException>
protect_public_send
returns Result<AnyObject, AnyObject> Read moresource§fn to_any_object(&self) -> AnyObject
fn to_any_object(&self) -> AnyObject
AnyObject
Read more