Struct magnus::r_struct::RStruct

#[repr(transparent)]
pub struct RStruct(_);

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

All Value methods should be available on this type through Deref, but some may be missed by this documentation.

Implementations

impl RStruct

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

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

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

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.

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

Return the value for the member at index.

index may be an integer, string, or Symbol.

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

Return the value for the member at index.

index may be an integer, string, or Symbol.

pub fn size(self) -> usize

Returns the count of members this struct has.

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

Returns the member names for this struct as Symbols.

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

Return the value for the member named id.

Methods from Deref<Target = Value>

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

Convert self to a Rust string.

Safety

This may return a direct view of memory owned and managed by Ruby. Ruby may modify or free the memory backing the returned str, the caller must ensure this does not happen.

This can be used safely by immediately calling into_owned on the return value.

Examples

use magnus::{eval, QTRUE};

let value = QTRUE;
// safe as we neve give Ruby a chance to free the string.
let s = unsafe { value.to_s() }.unwrap().into_owned();
assert_eq!(s, "true");

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

Return the name of self’s class.

Safety

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

This can be used safely by immediately calling into_owned on the return value.

Examples

use magnus::{eval, RHash};

let value = RHash::new();
// safe as we never give Ruby a chance to free the string.
let s = unsafe { value.classname() }.into_owned();
assert_eq!(s, "Hash");

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 Deref for RStruct

type Target = Value

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for RStruct

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

Formats the value using the given formatter.

impl From<RStruct> for Value

fn from(val: RStruct) -> Self

Converts to this type from the input type.

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: Into<Id>,
    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: Into<Id>,
    U: Into<Value>,

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 TryConvert for RStruct

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

Convert val into Self.

impl Copy for RStruct