Struct magnus::r_struct::RStruct

pub struct RStruct(/* private fields */);

A Value pointer to a RStruct struct, Ruby’s internal representation of ‘Structs’.

See the ReprValue and Object traits for additional methods available on this type.

Implementations

impl RStruct

pub fn from_value(val: Value) -> Option<Self>

Return Some(RStruct) if val is a RStruct, None otherwise.

Examples

use magnus::{define_global_const, eval, r_struct::define_struct, RStruct};

let struct_class = define_struct(None, ("foo", "bar")).unwrap();
define_global_const("Example", struct_class).unwrap();

assert!(RStruct::from_value(eval(r#"Example.new(1, 2)"#).unwrap()).is_some());
assert!(RStruct::from_value(eval(r#"Object.new"#).unwrap()).is_none());

pub unsafe fn as_slice(&self) -> &[Value]

👎Deprecated since 0.6.0

Return the members of the struct as a slice of Values. The order will be the order the of the member names when the struct class was defined.

Safety

Ruby may modify or free the memory backing the returned slice, the caller must ensure this does not happen.

pub fn get<T>(self, index: usize) -> Result<T, Error>

where T: TryConvert,

Return the value for the member at index, where members are ordered as per the member names when the struct class was defined.

Examples

use magnus::{prelude::*, r_struct::define_struct, RStruct};

let struct_class = define_struct(None, ("foo", "bar")).unwrap();
let instance = RStruct::from_value(struct_class.new_instance((1, 2)).unwrap()).unwrap();
assert_eq!(instance.get::<i64>(0).unwrap(), 1);
assert_eq!(instance.get::<i64>(1).unwrap(), 2);

pub fn aref<T, U>(self, index: T) -> Result<U, Error>

where T: IntoValue, U: TryConvert,

Return the value for the member at index.

index may be an integer, string, or Symbol.

Examples

use magnus::{prelude::*, r_struct::define_struct, RStruct, Symbol};

let struct_class = define_struct(None, ("foo", "bar", "baz")).unwrap();
let instance = RStruct::from_value(struct_class.new_instance((1, 2, 3)).unwrap()).unwrap();
assert_eq!(instance.aref::<_, i64>(0).unwrap(), 1);
assert_eq!(instance.aref::<_, i64>("bar").unwrap(), 2);
assert_eq!(instance.aref::<_, i64>(Symbol::new("baz")).unwrap(), 3);

pub fn aset<T, U>(self, index: T, val: U) -> Result<(), Error>

where T: IntoValue, U: IntoValue,

Set the value for the member at index.

index may be an integer, string, or Symbol.

Examples

use magnus::{prelude::*, r_struct::define_struct, rb_assert, RStruct, Symbol};

let struct_class = define_struct(None, ("foo", "bar", "baz")).unwrap();
let instance = RStruct::from_value(struct_class.new_instance((1, 2, 3)).unwrap()).unwrap();

instance.aset(0, 4).unwrap();
rb_assert!("instance.foo == 4", instance);

instance.aset("bar", 5).unwrap();
rb_assert!("instance.bar == 5", instance);

instance.aset(Symbol::new("baz"), 6).unwrap();
rb_assert!("instance.baz == 6", instance);

pub fn size(self) -> usize

Returns the count of members this struct has.

Examples

use magnus::{prelude::*, r_struct::define_struct, RStruct};

let struct_class = define_struct(None, ("foo", "bar", "baz")).unwrap();
let instance = RStruct::from_value(struct_class.new_instance(()).unwrap()).unwrap();

assert_eq!(instance.size(), 3);

pub fn members(self) -> Result<Vec<Cow<'static, str>>, Error>

Returns the member names for this struct.

Examples

use magnus::{prelude::*, r_struct::define_struct, RStruct};

let struct_class = define_struct(None, ("foo", "bar", "baz")).unwrap();
let instance = RStruct::from_value(struct_class.new_instance(()).unwrap()).unwrap();

assert_eq!(instance.members().unwrap(), &["foo", "bar", "baz"]);

pub fn getmember<T, U>(self, id: T) -> Result<U, Error>

where T: IntoId, U: TryConvert,

Return the value for the member named id.

Examples

use magnus::{prelude::*, r_struct::define_struct, RStruct};

let struct_class = define_struct(None, ("foo", "bar")).unwrap();
let instance = RStruct::from_value(struct_class.new_instance((1, 2)).unwrap()).unwrap();
assert_eq!(instance.getmember::<_, i64>("foo").unwrap(), 1);
assert_eq!(instance.getmember::<_, i64>("bar").unwrap(), 2);

Trait Implementations

impl Clone for RStruct

fn clone(&self) -> RStruct

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RStruct

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

Formats the value using the given formatter.

impl Display for RStruct

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

Formats the value using the given formatter.

impl IntoValue for RStruct

fn into_value_with(self, _: &Ruby) -> Value

Convert self into Value.

fn into_value(self) -> Value

Convert self into Value.

unsafe fn into_value_unchecked(self) -> Value

Convert self into Value.

impl Object for RStruct

fn define_singleton_method<M>(self, name: &str, func: M) -> Result<(), Error>

where M: Method,

Define a singleton method in self’s scope.

fn ivar_get<T, U>(self, name: T) -> Result<U, Error>

where T: IntoId, U: TryConvert,

Get the value for the instance variable name within self’s scope.

fn ivar_set<T, U>(self, name: T, value: U) -> Result<(), Error>

where T: IntoId, U: IntoValue,

Set the value for the instance variable name within self’s scope.

fn singleton_class(self) -> Result<RClass, Error>

Finds or creates the singleton class of self.

fn extend_object(self, module: RModule) -> Result<(), Error>

Extend self with module.

impl ReprValue for RStruct

fn as_value(self) -> Value

Return self as a Value.

fn is_nil(self) -> bool

Returns whether self is Ruby’s nil value.

fn equal<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #==.

fn eql<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #eql?.

fn hash(self) -> Result<Integer, Error>

Returns an integer non-uniquely identifying self.

fn class(self) -> RClass

Returns the class that self is an instance of.

fn is_frozen(self) -> bool

Returns whether self is ‘frozen’.

fn check_frozen(self) -> Result<(), Error>

Returns an error if self is ‘frozen’.

fn freeze(self)

Mark self as frozen.

fn to_bool(self) -> bool

Convert self to a bool, following Ruby’s rules of false and nil as boolean false and everything else boolean true.

fn funcall<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args.

fn funcall_public<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the public method named method on self with args.

fn check_funcall<M, A, T>(self, method: M, args: A) -> Option<Result<T, Error>>

where M: IntoId, A: ArgList, T: TryConvert,

If self responds to the method named method, call it with args.

fn funcall_with_block<M, A, T>( self, method: M, args: A, block: Proc ) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args and block.

fn block_call<M, A, R, T>( self, method: M, args: A, block: fn(_: &[Value], _: Option<Proc>) -> R ) -> Result<T, Error>

where M: IntoId, A: ArgList, R: BlockReturn, T: TryConvert,

Call the method named method on self with args and block.

fn respond_to<M>(self, method: M, include_private: bool) -> Result<bool, Error>

where M: IntoId,

Check if self responds to the given Ruby method.

fn to_r_string(self) -> Result<RString, Error>

Convert self to a Ruby String.

unsafe fn to_s(&self) -> Result<Cow<'_, str>, Error>

Convert self to a Rust string.

fn inspect(self) -> String

Convert self to its Ruby debug representation.

unsafe fn classname(&self) -> Cow<'_, str>

Return the name of self’s class.

fn is_kind_of<T>(self, class: T) -> bool

where T: ReprValue + Module,

Returns whether or not self is an instance of class.

fn enumeratorize<M, A>(self, method: M, args: A) -> Enumerator

where M: IntoSymbol, A: ArgList,

Generate an Enumerator from method on self, passing args to method.

impl TryConvert for RStruct

fn try_convert(val: Value) -> Result<Self, Error>

Convert val into Self.

impl Copy for RStruct