#[repr(transparent)]pub struct RStruct(_);
Expand description
Implementations
sourceimpl RStruct
impl RStruct
sourcepub fn from_value(val: Value) -> Option<Self>
pub fn from_value(val: Value) -> Option<Self>
Return Some(RStruct)
if val
is a RStruct
, None
otherwise.
sourcepub fn get<T>(self, index: usize) -> Result<T, Error> where
T: TryConvert,
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.
sourcepub fn aref<T, U>(self, index: T) -> Result<U, Error> where
T: Into<Value>,
U: TryConvert,
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
.
sourcepub fn aset<T, U>(self, index: T, val: U) -> Result<(), Error> where
T: Into<Value>,
U: Into<Value>,
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
.
Methods from Deref<Target = Value>
sourcepub unsafe fn to_s(&self) -> Result<Cow<'_, str>, Error>
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");
sourcepub unsafe fn classname(&self) -> Cow<'_, str>
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 neve give Ruby a chance to free the string.
let s = unsafe { value.classname() }.into_owned();
assert_eq!(s, "Hash");
sourcepub fn try_convert<T>(&self) -> Result<T, Error> where
T: TryConvert,
pub fn try_convert<T>(&self) -> Result<T, Error> where
T: TryConvert,
Convert self
to the Rust type T
.
See the types that TryConvert
is implemented on for what this
method can convert to.
Examples
use magnus::{eval, Value};
assert_eq!(eval::<Value>("42").unwrap().try_convert::<i64>().unwrap(), 42);
assert_eq!(eval::<Value>("1.23").unwrap().try_convert::<i64>().unwrap(), 1);
assert_eq!(eval::<Value>("1").unwrap().try_convert::<f64>().unwrap(), 1.0);
assert_eq!(eval::<Value>("nil").unwrap().try_convert::<Option<i64>>().unwrap(), None);
assert_eq!(eval::<Value>("42").unwrap().try_convert::<Option<i64>>().unwrap(), Some(42));
Trait Implementations
sourceimpl Object for RStruct
impl Object for RStruct
sourcefn define_singleton_method<M>(self, name: &str, func: M) where
M: Method,
fn define_singleton_method<M>(self, name: &str, func: M) where
M: Method,
Define a singleton method in self
’s scope. Read more
sourceimpl TryConvert for RStruct
impl TryConvert for RStruct
sourcefn try_convert(val: &Value) -> Result<Self, Error>
fn try_convert(val: &Value) -> Result<Self, Error>
Convert val
into Self
.
impl Copy for RStruct
Auto Trait Implementations
impl RefUnwindSafe for RStruct
impl Send for RStruct
impl Sync for RStruct
impl Unpin for RStruct
impl UnwindSafe for RStruct
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more