Struct Value

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

Boxed Ruby value in the Artichoke interpreter.

Implementations

impl Value

pub fn new() -> Self

Create a new, empty Ruby value.

Alias for Value::default.

pub fn nil() -> Self

Create a nil Ruby Value.

pub fn is_unreachable(&self) -> bool

Whether a value is an interpreter-only variant not exposed to Ruby.

Some type tags like MRB_TT_UNDEF are internal to the mruby VM and manipulating them with the sys API is unspecified and may result in a segfault.

After extracting a sys::mrb_value from the interpreter, check to see if the value is unreachable a Fatal exception.

See: mruby#4460.

pub fn is_dead(&self, interp: &mut Artichoke) -> bool

Return whether this object is unreachable by any GC roots.

pub fn is_range( &self, interp: &mut Artichoke, len: i64, ) -> Result<Option<Range>, Error>

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Convert<Option<Value>, Value> for Artichoke

fn convert(&self, value: Option<Value>) -> Value

Performs the infallible conversion.

impl Convert<Option<bool>, Value> for Artichoke

fn convert(&self, value: Option<bool>) -> Value

Performs the infallible conversion.

impl Convert<Option<i64>, Value> for Artichoke

fn convert(&self, value: Option<i64>) -> Value

Performs the infallible conversion.

impl Convert<Value, Option<Value>> for Artichoke

fn convert(&self, value: Value) -> Option<Value>

Performs the infallible conversion.

impl Convert<Value, Value> for Artichoke

fn convert(&self, value: Value) -> Value

Performs the infallible conversion.

impl Convert<bool, Value> for Artichoke

fn convert(&self, value: bool) -> Value

Performs the infallible conversion.

impl Convert<i16, Value> for Artichoke

fn convert(&self, value: i16) -> Value

Performs the infallible conversion.

impl Convert<i32, Value> for Artichoke

fn convert(&self, value: i32) -> Value

Performs the infallible conversion.

impl Convert<i64, Value> for Artichoke

fn convert(&self, value: i64) -> Value

Performs the infallible conversion.

impl Convert<i8, Value> for Artichoke

fn convert(&self, value: i8) -> Value

Performs the infallible conversion.

impl Convert<u16, Value> for Artichoke

fn convert(&self, value: u16) -> Value

Performs the infallible conversion.

impl Convert<u32, Value> for Artichoke

fn convert(&self, value: u32) -> Value

Performs the infallible conversion.

impl Convert<u8, Value> for Artichoke

fn convert(&self, value: u8) -> Value

Performs the infallible conversion.

impl ConvertMut<Rand, Value> for Artichoke

fn convert_mut(&mut self, from: Rand) -> Value

Performs the infallible conversion.

impl ConvertMut<Rand, Value> for Artichoke

fn convert_mut(&mut self, from: Rand) -> Value

Performs the infallible conversion.

impl ConvertMut<Value, Options> for Artichoke

fn convert_mut(&mut self, value: Value) -> Options

Performs the infallible conversion.

impl ConvertMut<Value, Value> for Artichoke

fn convert_mut(&mut self, value: Value) -> Value

Performs the infallible conversion.

impl ConvertMut<f64, Value> for Artichoke

fn convert_mut(&mut self, value: f64) -> Value

Performs the infallible conversion.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Value

Returns the “default value” for a type.

impl From<Option<Value>> for Value

fn from(value: Option<Value>) -> Self

Converts to this type from the input type.

impl From<Option<mrb_value>> for Value

fn from(value: Option<mrb_value>) -> Self

Converts to this type from the input type.

impl From<Value> for NoBlockGiven

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Value> for mrb_value

fn from(value: Value) -> Self

Extract the inner sys::mrb_value from this Value.

impl From<mrb_value> for Value

fn from(value: mrb_value) -> Self

Construct a new Value from a sys::mrb_value.

impl PartialEq for Value

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

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

const 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 TryConvert<Option<usize>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: Option<usize>) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvert<Value, Option<bool>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: Value) -> Result<Option<bool>, Self::Error>

Performs the fallible conversion.

impl TryConvert<Value, Option<i64>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: Value) -> Result<Option<i64>, Self::Error>

Performs the fallible conversion.

impl TryConvert<Value, bool> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: Value) -> Result<bool, Self::Error>

Performs the fallible conversion.

impl TryConvert<Value, f64> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: Value) -> Result<f64, Self::Error>

Performs the fallible conversion.

impl TryConvert<Value, i64> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: Value) -> Result<i64, Self::Error>

Performs the fallible conversion.

impl TryConvert<Value, u32> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: Value) -> Result<u32, Self::Error>

Performs the fallible conversion.

impl TryConvert<Value, usize> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: Value) -> Result<usize, Self::Error>

Performs the fallible conversion.

impl TryConvert<isize, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: isize) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvert<u64, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: u64) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvert<usize, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert(&self, value: usize) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[&[u8]], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: &[&[u8]]) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[&str], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: &[&str]) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[Option<&[u8]>], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: &[Option<&[u8]>], ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[Option<&str>], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: &[Option<&str>], ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[Option<Value>], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: &[Option<Value>], ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[Option<Vec<u8>>], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: &[Option<Vec<u8>>], ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[String], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: &[String]) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[Value], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: &[Value]) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[Vec<u8>], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: &[Vec<u8>]) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[i64], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: &[i64]) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&[u8], Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: &[u8]) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&OsStr, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: &OsStr) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<&str, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: &str) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Cow<'a, [u8]>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Cow<'a, [u8]>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Cow<'a, OsStr>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Cow<'a, OsStr>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Cow<'a, str>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Cow<'a, str>) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<HashMap<Vec<u8>, Vec<u8>>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: HashMap<Vec<u8>, Vec<u8>>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Option<&[u8]>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Option<&[u8]>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Option<&str>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Option<&str>) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Option<HashMap<Vec<u8>, Option<Vec<u8>>>>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Option<HashMap<Vec<u8>, Option<Vec<u8>>>>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Option<String>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Option<String>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Option<Vec<u8>>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Option<Vec<u8>>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<OsString, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: OsString) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<String, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: String) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Value, &'a [u8]> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Value) -> Result<&'a [u8], Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Value, &'a str> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Value) -> Result<&'a str, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Encoding> for Artichoke

type Error = InvalidEncodingError

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Value) -> Result<Encoding, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Max> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, max: Value) -> Result<Max, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Max> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, max: Value) -> Result<Max, Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Value, Option<&'a [u8]>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Value, ) -> Result<Option<&'a [u8]>, Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Value, Option<&'a str>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Value, ) -> Result<Option<&'a str>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Option<Offset>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, options: Value, ) -> Result<Option<Offset>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Option<String>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Value, ) -> Result<Option<String>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Option<Vec<u8>>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Value, ) -> Result<Option<Vec<u8>>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, String> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Value) -> Result<String, Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Value, Vec<&'a [u8]>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Value, ) -> Result<Vec<&'a [u8]>, Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Value, Vec<&'a str>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Value) -> Result<Vec<&'a str>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Vec<(Value, Value)>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Value, ) -> Result<Vec<(Value, Value)>, Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Value, Vec<Option<&'a [u8]>>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Value, ) -> Result<Vec<Option<&'a [u8]>>, Self::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<Value, Vec<Option<&'a str>>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Value, ) -> Result<Vec<Option<&'a str>>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Vec<Option<String>>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Value, ) -> Result<Vec<Option<String>>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Vec<Option<Vec<u8>>>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Value, ) -> Result<Vec<Option<Vec<u8>>>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Vec<String>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Value) -> Result<Vec<String>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Vec<Value>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Value) -> Result<Vec<Value>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Vec<Vec<u8>>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Value) -> Result<Vec<Vec<u8>>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Vec<i64>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Value) -> Result<Vec<i64>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Vec<u8>> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Value) -> Result<Vec<u8>, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<&[u8]>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Vec<&[u8]>) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<&str>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Vec<&str>) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<(Value, Value)>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Vec<(Value, Value)>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<(Vec<u8>, Vec<i64>)>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Vec<(Vec<u8>, Vec<i64>)>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<Option<&[u8]>>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Vec<Option<&[u8]>>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<Option<&str>>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Vec<Option<&str>>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<Option<Vec<u8>>>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Vec<Option<Vec<u8>>>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<String>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Vec<String>) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<Value>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Vec<Value>) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<Vec<Option<&[u8]>>>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Vec<Vec<Option<&[u8]>>>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<Vec<Option<&str>>>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Vec<Vec<Option<&str>>>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<Vec<Option<Vec<u8>>>>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut( &mut self, value: Vec<Vec<Option<Vec<u8>>>>, ) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<Vec<u8>>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Vec<Vec<u8>>) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<i64>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Vec<i64>) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl TryConvertMut<Vec<u8>, Value> for Artichoke

type Error = Error

Error type for failed conversions.

fn try_convert_mut(&mut self, value: Vec<u8>) -> Result<Value, Self::Error>

Performs the fallible conversion.

impl Value for Value

type Artichoke = Artichoke

Concrete type for Artichoke interpreter.

type Arg = Value

Concrete type for arguments passed to funcall.

type Value = Value

Concrete type for results from funcall.

type Block = Value

Concrete type for blocks passed to funcall.

type Error = Error

Concrete error type for funcall errors.

fn funcall( &self, interp: &mut Self::Artichoke, func: &str, args: &[Self::Arg], block: Option<Self::Block>, ) -> Result<Self::Value, Self::Error>

Call a method on this Value with arguments and an optional block.

fn freeze(&mut self, interp: &mut Self::Artichoke) -> Result<(), Self::Error>

Call #freeze on this Value.

fn is_frozen(&self, interp: &mut Self::Artichoke) -> bool

Call #frozen? on this Value.

fn inspect(&self, interp: &mut Self::Artichoke) -> Vec<u8>

Call #inspect on this Value.

fn is_nil(&self) -> bool

Whether self is nil

fn respond_to( &self, interp: &mut Self::Artichoke, method: &str, ) -> Result<bool, Self::Error>

Whether self responds to a method.

fn to_s(&self, interp: &mut Self::Artichoke) -> Vec<u8>

Call #to_s on this Value.

fn ruby_type(&self) -> Ruby

Return this values Rust-mapped type tag.

fn try_convert_into<T>(self, interp: &Self::Artichoke) -> Result<T, Self::Error>

where Self: Sized, Self::Artichoke: TryConvert<Self, T, Error = Self::Error>,

Consume self and try to convert self to type T using a TryConvert conversion.

fn try_convert_into_mut<T>( self, interp: &mut Self::Artichoke, ) -> Result<T, Self::Error>

where Self: Sized, Self::Artichoke: TryConvertMut<Self, T, Error = Self::Error>,

Consume self and try to convert self to type T using a TryConvertMut conversion.

impl Copy for Value