Struct Value 

#[repr(transparent)]
pub struct Value(pub VALUE);

Wraps a plain old Ruby FFI VALUE with much more functionality.

Tuple Fields

0: VALUE

Implementations

impl Value

pub const NIL: Self

The Ruby nil value.

pub const TRUE: Self

The Ruby true value.

pub const FALSE: Self

The Ruby false value.

pub fn send( &self, method_name: &str, arguments: &[Value], ) -> Result<Value, CaughtException>

Sends a Ruby method and returns the result.

pub unsafe fn send_unprotected( &self, method_name: &str, arguments: &[Value], ) -> Value

Sends a Ruby method without rescuing Ruby unwind.

pub fn constant(&self, constant_name: &str) -> Result<Value, CaughtException>

Gets a constant by name. Equivalent to Object#const_get(constant_name).

pub unsafe fn constant_unprotected(&self, constant_name: &str) -> Value

Gets a constant by name. Equivalent to Object#const_get(constant_name).

pub fn set_constant( &self, constant_name: &str, value: Value, ) -> Result<(), CaughtException>

Sets a constant. Equivalent to Object#const_set(constant_name, value).

pub unsafe fn set_constant_unprotected(&self, constant_name: &str, value: Value)

Sets a constant. Equivalent to Object#const_set(constant_name, value).

pub fn to_s(&self) -> Result<String, CaughtException>

Convert a Ruby value to a Rust string.

Calls Object#to_s and then converts the result to a string.

pub unsafe fn to_s_unprotected(&self) -> String

Convert a Ruby value to a Rust string.

pub fn object_class_name(&self) -> String

Convert a Ruby string to a Rust string. Gets the class name for an object

pub fn inspect(&self) -> Result<Value, CaughtException>

Calls Object#inspect

pub unsafe fn inspect_unprotected(&self) -> Value

Calls Object#inspect

pub fn is_of_value_type(&self, value_type: value_type) -> bool

Checks if this object is of the given value type.

pub fn is_nil(&self) -> bool

Checks if this value is nil.

pub fn convert_array(values: &[Value]) -> &[VALUE]

Trait Implementations

impl AsRef<VALUE> for Value

fn as_ref(&self) -> &VALUE

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Deref for Value

type Target = VALUE

The resulting type after dereferencing.

fn deref(&self) -> &VALUE

Dereferences the value.

impl DerefMut for Value

fn deref_mut(&mut self) -> &mut VALUE

Mutably dereferences the value.

impl Display for Value

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

Formats the value using the given formatter.

impl From<VALUE> for Value

fn from(v: VALUE) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl FromStr for Value

type Err = CaughtException

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, CaughtException>

Parses a string s to return a value of this type.

impl Into<VALUE> for Value

fn into(self) -> VALUE

Converts this type into the (usually inferred) input type.

impl PartialEq for Value

fn eq(&self, other: &Value) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Value

impl Eq for Value

impl StructuralPartialEq for Value