Struct artichoke::Artichoke

pub struct Artichoke {
    pub mrb: NonNull<mrb_state>,
    pub state: Option<Box<State, Global>>,
}

Interpreter instance.

Functionality is added to the interpreter via traits, for example, garbage collection or eval.

Fields

mrb: NonNull<mrb_state>

Underlying mruby interpreter.

This is an owned reference to the interpreter via a mutable pointer.

state: Option<Box<State, Global>>

Interpreter state.

This field is an Option because the State is moved in and out of the Artichoke struct as the call graph crosses between Rust and C and C to Rust.

Implementations

impl Artichoke

pub const fn new(
    mrb: NonNull<mrb_state>,
    state: Box<State, Global>
) -> Artichoke

Create a new interpreter from an underlying mrb and a State.

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

Prevent the given value from being garbage collected.

Calls sys::mrb_gc_protect on this value which adds it to the GC arena. This object will remain in the arena until ArenaIndex::restore restores the arena to an index before this call to protect.

pub unsafe fn with_ffi_boundary<F, T>(
    &mut self,
    func: F
) -> Result<T, InterpreterExtractError> where
    F: FnOnce(*mut mrb_state) -> T, 

Execute a a closure by moving the State into the mrb instance.

This method prepares this interpreter to cross an FFI boundary. When the Artichoke implementation calls mruby FFI functions, the State must be moved into the sys::mrb_state userdata pointer.

Safety

This method moves the State out of this instance into the mrb instance. During this function’s execution, this instance may be partially initialized.

This function is only safe to call if the closure only calls FFI functions that use a raw *mut sys::mrb_state.

pub unsafe fn into_raw(interp: Artichoke) -> *mut mrb_state

Consume an interpreter and return the pointer to the underlying sys::mrb_state.

This function does not free any interpreter resources. Its intended use is to prepare the interpreter to cross over an FFI boundary.

This is an associated function and must be called as Artichoke::into_raw(interp).

Safety

After calling this function, the caller is responsible for properly freeing the memory occupied by the interpreter heap. The easiest way to do this is to call ffi::from_user_data with the returned pointer and then call Artichoke::close.

pub fn close(self)

Consume an interpreter and free all live objects.

impl Artichoke

pub fn lookup_symbol_with_trailing_nul(
    &self,
    symbol: u32
) -> Result<Option<&[u8]>, Error>

pub fn intern_bytes_with_trailing_nul<T>(
    &mut self,
    bytes: T
) -> Result<u32, Error> where
    T: Into<Cow<'static, [u8]>>, 

pub fn check_interned_bytes_with_trailing_nul(
    &self,
    bytes: &[u8]
) -> Result<Option<u32>, Error>

Trait Implementations

impl<'a> AsMut<Artichoke> for Guard<'a>

pub fn as_mut(&mut self) -> &mut Artichoke

Performs the conversion.

impl<'a> AsRef<Artichoke> for Guard<'a>

pub fn as_ref(&self) -> &Artichoke

Performs the conversion.

impl ClassRegistry for Artichoke

pub fn def_class<T>(&mut self, spec: Spec) -> Result<(), Error> where
    T: Any, 

Create a class definition bound to a Rust type T.

Class definitions have the same lifetime as the State because the class def owns the mrb_data_type for the type, which must be long-lived.

pub fn class_spec<T>(&self) -> Result<Option<&Spec>, Error> where
    T: Any, 

Retrieve a class definition from the state bound to Rust type T.

This function returns None if type T has not had a class spec registered for it using ClassRegistry::def_class.

pub fn class_of<T>(&mut self) -> Result<Option<Value>, Error> where
    T: Any, 

pub fn new_instance<T>(
    &mut self,
    args: &[Value]
) -> Result<Option<Value>, Error> where
    T: Any, 

fn is_class_defined<T>(&self) -> bool where
    T: Any, 

impl CoerceToNumeric for Artichoke

type Value = Value

Concrete type of boxed Ruby value as inputs to coerce functions.

type Float = f64

Concrete float type to coerce values into, e.g. f64.

type Error = Error

Concrete error type for errors encountered when coercing values.

pub fn coerce_to_float(
    &mut self,
    value: <Artichoke as CoerceToNumeric>::Value
) -> Result<<Artichoke as CoerceToNumeric>::Float, <Artichoke as CoerceToNumeric>::Error>

Coerce the given Ruby value to a Float.

impl Convert<Integer, Value> for Artichoke

pub fn convert(&self, from: Integer) -> Value

Performs the infallible conversion.

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

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

Performs the infallible conversion.

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

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

Performs the infallible conversion.

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

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

Performs the infallible conversion.

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

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

Performs the infallible conversion.

impl Convert<Value, Value> for Artichoke

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

Performs the infallible conversion.

impl Convert<bool, Value> for Artichoke

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

Performs the infallible conversion.

impl Convert<i16, Value> for Artichoke

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

Performs the infallible conversion.

impl Convert<i32, Value> for Artichoke

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

Performs the infallible conversion.

impl Convert<i64, Value> for Artichoke

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

Performs the infallible conversion.

impl Convert<i8, Value> for Artichoke

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

Performs the infallible conversion.

impl Convert<u16, Value> for Artichoke

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

Performs the infallible conversion.

impl Convert<u32, Value> for Artichoke

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

Performs the infallible conversion.

impl Convert<u8, Value> for Artichoke

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

Performs the infallible conversion.

impl<'_> ConvertMut<&'_ [u8], Value> for Artichoke

pub fn convert_mut(&mut self, value: &[u8]) -> Value

Performs the infallible conversion.

impl<'_> ConvertMut<&'_ str, Value> for Artichoke

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

Performs the infallible conversion.

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

pub fn convert_mut(&mut self, value: Cow<'a, [u8]>) -> Value

Performs the infallible conversion.

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

pub fn convert_mut(&mut self, value: Cow<'a, str>) -> Value

Performs the infallible conversion.

impl ConvertMut<Float, Value> for Artichoke

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

Performs the infallible conversion.

impl ConvertMut<HashMap<Vec<u8, Global>, Vec<u8, Global>, RandomState>, Value> for Artichoke

pub fn convert_mut(
    &mut self,
    value: HashMap<Vec<u8, Global>, Vec<u8, Global>, RandomState>
) -> Value

Performs the infallible conversion.

impl<'_> ConvertMut<Option<&'_ [u8]>, Value> for Artichoke

pub fn convert_mut(&mut self, value: Option<&[u8]>) -> Value

Performs the infallible conversion.

impl<'_> ConvertMut<Option<&'_ str>, Value> for Artichoke

pub fn convert_mut(&mut self, value: Option<&str>) -> Value

Performs the infallible conversion.

impl ConvertMut<Option<HashMap<Vec<u8, Global>, Option<Vec<u8, Global>>, RandomState>>, Value> for Artichoke

pub fn convert_mut(
    &mut self,
    value: Option<HashMap<Vec<u8, Global>, Option<Vec<u8, Global>>, RandomState>>
) -> Value

Performs the infallible conversion.

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

pub fn convert_mut(&mut self, value: Option<String>) -> Value

Performs the infallible conversion.

impl ConvertMut<Option<Vec<u8, Global>>, Value> for Artichoke

pub fn convert_mut(&mut self, value: Option<Vec<u8, Global>>) -> Value

Performs the infallible conversion.

impl ConvertMut<Outcome, Value> for Artichoke

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

Performs the infallible conversion.

impl ConvertMut<Rand, Value> for Artichoke

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

Performs the infallible conversion.

impl ConvertMut<Rand, Value> for Artichoke

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

Performs the infallible conversion.

impl ConvertMut<String, Value> for Artichoke

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

Performs the infallible conversion.

impl ConvertMut<Value, Options> for Artichoke

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

Performs the infallible conversion.

impl ConvertMut<Value, Value> for Artichoke

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

Performs the infallible conversion.

impl ConvertMut<Vec<(Value, Value), Global>, Value> for Artichoke

pub fn convert_mut(&mut self, value: Vec<(Value, Value), Global>) -> Value

Performs the infallible conversion.

impl ConvertMut<Vec<u8, Global>, Value> for Artichoke

pub fn convert_mut(&mut self, value: Vec<u8, Global>) -> Value

Performs the infallible conversion.

impl ConvertMut<f64, Value> for Artichoke

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

Performs the infallible conversion.

impl Debug for Artichoke

type Value = Value

Concrete type for return values from eval.

pub fn inspect_type_name_for_value(
    &mut self,
    value: <Artichoke as Debug>::Value
) -> &str

Return a name for the given value’s type that is suitable for using in an Exception message.

pub fn class_name_for_value(
    &mut self,
    value: <Artichoke as Debug>::Value
) -> &str

Return the class name for the given value’s type.

impl Debug for Artichoke

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

Formats the value using the given formatter.

impl DefineConstant for Artichoke

type Value = Value

Concrete type for Ruby values.

type Error = Error

Concrete error type for fallible operations.

pub fn define_global_constant(
    &mut self,
    constant: &str,
    value: <Artichoke as DefineConstant>::Value
) -> Result<(), <Artichoke as DefineConstant>::Error>

Define a global constant.

pub fn define_class_constant<T>(
    &mut self,
    constant: &str,
    value: <Artichoke as DefineConstant>::Value
) -> Result<(), <Artichoke as DefineConstant>::Error> where
    T: 'static, 

Define a class constant.

pub fn define_module_constant<T>(
    &mut self,
    constant: &str,
    value: <Artichoke as DefineConstant>::Value
) -> Result<(), <Artichoke as DefineConstant>::Error> where
    T: 'static, 

Define a module constant.

impl Eval for Artichoke

type Value = Value

Concrete type for return values from eval.

type Error = Error

Concrete error type for eval functions.

pub fn eval(
    &mut self,
    code: &[u8]
) -> Result<<Artichoke as Eval>::Value, <Artichoke as Eval>::Error>

Eval code on the Artichoke interpreter using the current Context.

pub fn eval_os_str(
    &mut self,
    code: &OsStr
) -> Result<<Artichoke as Eval>::Value, <Artichoke as Eval>::Error>

Eval code on the Artichoke interpreter using the current Context when given code as an OsStr.

pub fn eval_file(
    &mut self,
    file: &Path
) -> Result<<Artichoke as Eval>::Value, <Artichoke as Eval>::Error>

Eval code on the Artichoke interpreter using a new file Context given a file path.

impl Globals for Artichoke

pub fn unset_global_variable<T>(
    &mut self,
    name: T
) -> Result<(), <Artichoke as Globals>::Error> where
    T: Into<Cow<'static, [u8]>>, 

Unset global variable pointed to by name.

Unsetting a global variable removes the name from the global storage table. Unset globals resolve to nil in the Ruby VM.

Unsetting a global that is currently unset is a no-op.

Errors

If the name is not a valid global name, an error is returned.

type Value = Value

Concrete value type for global variables.

type Error = Error

Concrete error type for failures manipulating global variables.

pub fn set_global_variable<T>(
    &mut self,
    name: T,
    value: &<Artichoke as Globals>::Value
) -> Result<(), <Artichoke as Globals>::Error> where
    T: Into<Cow<'static, [u8]>>, 

Set global variable pointed to by name to the given Ruby value.

pub fn get_global_variable<T>(
    &mut self,
    name: T
) -> Result<Option<<Artichoke as Globals>::Value>, <Artichoke as Globals>::Error> where
    T: Into<Cow<'static, [u8]>>, 

Get the Ruby value stored in the global variable pointed to by name.

impl Intern for Artichoke

type Symbol = u32

Concrete type for symbol identifiers.

type Error = Error

Concrete type for errors returned while interning symbols.

pub const SYMBOL_RANGE_START: <Artichoke as Intern>::Symbol

The initial Symbol index returned by the interner.

pub fn intern_bytes<T>(
    &mut self,
    bytes: T
) -> Result<<Artichoke as Intern>::Symbol, <Artichoke as Intern>::Error> where
    T: Into<Cow<'static, [u8]>>, 

Store an immutable bytestring for the life of the interpreter.

pub fn check_interned_bytes(
    &self,
    bytes: &[u8]
) -> Result<Option<<Artichoke as Intern>::Symbol>, <Artichoke as Intern>::Error>

Check if a bytestring is already interned and return its symbol identifier. Return None if the string has not been interned before.

pub fn lookup_symbol(
    &self,
    symbol: <Artichoke as Intern>::Symbol
) -> Result<Option<&[u8]>, <Artichoke as Intern>::Error>

Retrieve the original byte content of an interned bytestring.

pub fn symbol_count(&self) -> usize

Retrieve the number of unique strings interned.

fn intern_string<T>(&mut self, symbol: T) -> Result<Self::Symbol, Self::Error> where
    T: Into<Cow<'static, str>>, 

Store an immutable string for the life of the interpreter.

fn check_interned_string(
    &self,
    symbol: &str
) -> Result<Option<Self::Symbol>, Self::Error>

Check if a string is already interned and return its symbol identifier. Return None if the string has not been interned before.

impl Io for Artichoke

pub fn print<T>(&mut self, message: T) -> Result<(), <Artichoke as Io>::Error> where
    T: AsRef<[u8]>, 

Writes the given bytes to the interpreter stdout stream.

This implementation delegates to the underlying output strategy.

Errors

If the output stream encounters an error, an error is returned.

pub fn puts<T>(&mut self, message: T) -> Result<(), <Artichoke as Io>::Error> where
    T: AsRef<[u8]>, 

Writes the given bytes to the interpreter stdout stream followed by a newline.

This implementation delegates to the underlying output strategy.

Errors

If the output stream encounters an error, an error is returned.

type Error = Error

Concrete error type for errors encountered when reading and writing.

impl LoadSources for Artichoke

type Artichoke = Artichoke

Concrete type for interpreter.

type Error = Error

Concrete type for errors returned from filesystem IO.

type Exception = Error

Concrete type for errors returned by File::require.

pub fn def_file_for_type<P, T>(
    &mut self,
    path: P
) -> Result<(), <Artichoke as LoadSources>::Error> where
    P: AsRef<Path>,
    T: File<Artichoke = <Artichoke as LoadSources>::Artichoke, Error = <Artichoke as LoadSources>::Exception>, 

Add a Rust extension hook to the virtual filesystem. A stub Ruby file is added to the filesystem and File::require will dynamically define Ruby items when invoked via Kernel#require.

pub fn def_rb_source_file<P, T>(
    &mut self,
    path: P,
    contents: T
) -> Result<(), <Artichoke as LoadSources>::Error> where
    P: AsRef<Path>,
    T: Into<Cow<'static, [u8]>>, 

Add a Ruby source to the virtual filesystem.

pub fn resolve_source_path<P>(
    &self,
    path: P
) -> Result<Option<Vec<u8, Global>>, <Artichoke as LoadSources>::Error> where
    P: AsRef<Path>, 

Test for a source file at a path and return the absolute path of the resolved file.

pub fn source_is_file<P>(
    &self,
    path: P
) -> Result<bool, <Artichoke as LoadSources>::Error> where
    P: AsRef<Path>, 

Test for a source file at a path.

pub fn load_source<P>(
    &mut self,
    path: P
) -> Result<bool, <Artichoke as LoadSources>::Error> where
    P: AsRef<Path>, 

Load source located at the given path.

pub fn require_source<P>(
    &mut self,
    path: P
) -> Result<bool, <Artichoke as LoadSources>::Error> where
    P: AsRef<Path>, 

Require source located at the given path.

pub fn read_source_file_contents<P>(
    &self,
    path: P
) -> Result<Cow<'_, [u8]>, <Artichoke as LoadSources>::Error> where
    P: AsRef<Path>, 

Retrieve file contents for a source file.

impl ModuleRegistry for Artichoke

pub fn def_module<T>(&mut self, spec: Spec) -> Result<(), Error> where
    T: Any, 

Create a module definition bound to a Rust type T.

Module definitions have the same lifetime as the interpreter because the module def owns the mrb_data_type for the type, which must be long-lived.

pub fn module_spec<T>(&self) -> Result<Option<&Spec>, Error> where
    T: Any, 

Retrieve a module definition from the interpreter bound to Rust type T.

This function returns None if type T has not had a module spec registered for it using ModuleRegistry::def_module.

pub fn module_of<T>(&mut self) -> Result<Option<Value>, Error> where
    T: Any, 

fn is_module_defined<T>(&self) -> bool where
    T: Any, 

impl MrbGarbageCollection for Artichoke

pub fn create_arena_savepoint(
    &mut self
) -> Result<ArenaIndex<'_>, ArenaSavepointError>

Create a savepoint in the GC arena.

pub fn live_object_count(&mut self) -> i32

Retrieve the number of live objects on the interpreter heap.

pub fn mark_value(&mut self, value: &Value)

Mark a Value as reachable in the mruby garbage collector.

pub fn incremental_gc(&mut self)

Perform an incremental garbage collection.

pub fn full_gc(&mut self)

Perform a full garbage collection.

pub fn enable_gc(&mut self) -> State

Enable garbage collection.

pub fn disable_gc(&mut self) -> State

Disable garbage collection.

impl Parser for Artichoke

type Context = Context

Concrete type for parser context.

type Error = Error

Error type for Parser APIs.

pub fn reset_parser(&mut self) -> Result<(), <Artichoke as Parser>::Error>

Reset parser state to initial values.

pub fn fetch_lineno(&self) -> Result<usize, <Artichoke as Parser>::Error>

Fetch the current line number from the parser state.

pub fn add_fetch_lineno(
    &mut self,
    val: usize
) -> Result<usize, <Artichoke as Parser>::Error>

Increment line number and return the new value.

pub fn push_context(
    &mut self,
    context: <Artichoke as Parser>::Context
) -> Result<(), <Artichoke as Parser>::Error>

Set the currently active context by modifying the parser stack.

pub fn pop_context(
    &mut self
) -> Result<Option<<Artichoke as Parser>::Context>, <Artichoke as Parser>::Error>

Remove the current active context and return it.

pub fn peek_context(
    &self
) -> Result<Option<&<Artichoke as Parser>::Context>, <Artichoke as Parser>::Error>

Return a reference to the currently active context.

impl Prng for Artichoke

type Error = Error

Concrete type for PRNG errors.

type Prng = Random

Conrete type for the interpreter psuedorandom number generator.

pub fn prng(
    &self
) -> Result<&<Artichoke as Prng>::Prng, <Artichoke as Prng>::Error>

Return a shared reference to the interpreter psuedorandom number generator.

pub fn prng_mut(
    &mut self
) -> Result<&mut <Artichoke as Prng>::Prng, <Artichoke as Prng>::Error>

Return a mutable reference to the interpreter psuedorandom number generator.

impl Regexp for Artichoke

type Error = InterpreterExtractError

Concrete error type for errors encountered when manipulating Regexp state.

pub fn active_regexp_globals(
    &self
) -> Result<usize, <Artichoke as Regexp>::Error>

Retrieve the current number of set Regexp global variables.

pub fn set_active_regexp_globals(
    &mut self,
    count: usize
) -> Result<(), <Artichoke as Regexp>::Error>

Set the current number of set Regexp global variables.

pub fn clear_regexp(&mut self) -> Result<(), <Artichoke as Regexp>::Error>

Clear all Regexp state.

impl TopSelf for Artichoke

type Value = Value

Concrete Value type.

pub fn top_self(&mut self) -> Value

Return a Value-wrapped reference to “top self”.

impl<T, U> TryConvert<T, U> for Artichoke where
    Artichoke: Convert<T, U>, 

Provide a fallible converter for types that implement an infallible conversion.

pub fn try_convert(
    &self,
    value: T
) -> Result<U, <Artichoke as TryConvert<T, U>>::Error>

Blanket implementation that always succeeds by delegating to Convert::convert.

type Error = Error

Error type for failed conversions.

impl TryConvert<Value, Float> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: Value
) -> Result<Float, <Artichoke as TryConvert<Value, Float>>::Error>

Performs the fallible conversion.

impl TryConvert<Value, Integer> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: Value
) -> Result<Integer, <Artichoke as TryConvert<Value, Integer>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: Value
) -> Result<Option<bool>, <Artichoke as TryConvert<Value, Option<bool>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: Value
) -> Result<Option<i64>, <Artichoke as TryConvert<Value, Option<i64>>>::Error>

Performs the fallible conversion.

impl TryConvert<Value, bool> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: Value
) -> Result<bool, <Artichoke as TryConvert<Value, bool>>::Error>

Performs the fallible conversion.

impl TryConvert<Value, f64> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: Value
) -> Result<f64, <Artichoke as TryConvert<Value, f64>>::Error>

Performs the fallible conversion.

impl TryConvert<Value, i64> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: Value
) -> Result<i64, <Artichoke as TryConvert<Value, i64>>::Error>

Performs the fallible conversion.

impl TryConvert<Value, u32> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: Value
) -> Result<u32, <Artichoke as TryConvert<Value, u32>>::Error>

Performs the fallible conversion.

impl TryConvert<Value, usize> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: Value
) -> Result<usize, <Artichoke as TryConvert<Value, usize>>::Error>

Performs the fallible conversion.

impl TryConvert<isize, Value> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: isize
) -> Result<Value, <Artichoke as TryConvert<isize, Value>>::Error>

Performs the fallible conversion.

impl TryConvert<u64, Value> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: u64
) -> Result<Value, <Artichoke as TryConvert<u64, Value>>::Error>

Performs the fallible conversion.

impl TryConvert<usize, Value> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert(
    &self,
    value: usize
) -> Result<Value, <Artichoke as TryConvert<usize, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &[&[u8]]
) -> Result<Value, <Artichoke as TryConvertMut<&'_ [&'_ [u8]], Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &[&str]
) -> Result<Value, <Artichoke as TryConvertMut<&'_ [&'_ str], Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &[Option<&[u8]>]
) -> Result<Value, <Artichoke as TryConvertMut<&'_ [Option<&'_ [u8]>], Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &[Option<&str>]
) -> Result<Value, <Artichoke as TryConvertMut<&'_ [Option<&'_ str>], Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &[Option<Value>]
) -> Result<Value, <Artichoke as TryConvertMut<&'_ [Option<Value>], Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &[Option<Vec<u8, Global>>]
) -> Result<Value, <Artichoke as TryConvertMut<&'_ [Option<Vec<u8, Global>>], Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &[String]
) -> Result<Value, <Artichoke as TryConvertMut<&'_ [String], Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &[Value]
) -> Result<Value, <Artichoke as TryConvertMut<&'_ [Value], Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &[Vec<u8, Global>]
) -> Result<Value, <Artichoke as TryConvertMut<&'_ [Vec<u8, Global>], Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &[i64]
) -> Result<Value, <Artichoke as TryConvertMut<&'_ [i64], Value>>::Error>

Performs the fallible conversion.

impl<'_> TryConvertMut<&'_ OsStr, Value> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &OsStr
) -> Result<Value, <Artichoke as TryConvertMut<&'_ OsStr, Value>>::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<&'a mut Value, CaptureExtract<'a>> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &'a mut Value
) -> Result<CaptureExtract<'a>, <Artichoke as TryConvertMut<&'a mut Value, CaptureExtract<'a>>>::Error>

Performs the fallible conversion.

impl<'a> TryConvertMut<&'a mut Value, IntegerString<'a>> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: &'a mut Value
) -> Result<IntegerString<'a>, <Artichoke as TryConvertMut<&'a mut Value, IntegerString<'a>>>::Error>

Performs the fallible conversion.

impl TryConvertMut<(Option<Value>, Option<Value>), (Option<Options>, Option<Encoding>)> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: (Option<Value>, Option<Value>)
) -> Result<(Option<Options>, Option<Encoding>), <Artichoke as TryConvertMut<(Option<Value>, Option<Value>), (Option<Options>, Option<Encoding>)>>::Error>

Performs the fallible conversion.

impl TryConvertMut<CaptureMatch, Value> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: CaptureMatch
) -> Result<Value, <Artichoke as TryConvertMut<CaptureMatch, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

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

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    max: Option<Value>
) -> Result<Max, <Artichoke as TryConvertMut<Option<Value>, Max>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    max: Option<Value>
) -> Result<Max, <Artichoke as TryConvertMut<Option<Value>, Max>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Option<Value>
) -> Result<Option<Radix>, <Artichoke as TryConvertMut<Option<Value>, Option<Radix>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Option<Value>
) -> Result<Seed, <Artichoke as TryConvertMut<Option<Value>, Seed>>::Error>

Performs the fallible conversion.

impl TryConvertMut<OsString, Value> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: OsString
) -> Result<Value, <Artichoke as TryConvertMut<OsString, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    from: Scan
) -> Result<Option<Value>, <Artichoke as TryConvertMut<Scan, Option<Value>>>::Error>

Performs the fallible conversion.

impl<T, U> TryConvertMut<T, U> for Artichoke where
    Artichoke: ConvertMut<T, U>, 

Provide a mutable fallible converter for types that implement an infallible conversion.

pub fn try_convert_mut(
    &mut self,
    value: T
) -> Result<U, <Artichoke as TryConvertMut<T, U>>::Error>

Blanket implementation that always succeeds by delegating to Convert::convert.

type Error = Error

Error type for failed conversions.

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

type Error = Error

Error type for failed conversions.

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

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<&'a str, <Artichoke as TryConvertMut<Value, &'a str>>::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Encoding> for Artichoke

type Error = InvalidEncodingError

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Encoding, <Artichoke as TryConvertMut<Value, Encoding>>::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Max> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    max: Value
) -> Result<Max, <Artichoke as TryConvertMut<Value, Max>>::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Max> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    max: Value
) -> Result<Max, <Artichoke as TryConvertMut<Value, Max>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

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

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

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

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Option<String>, <Artichoke as TryConvertMut<Value, Option<String>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Option<Vec<u8, Global>>, <Artichoke as TryConvertMut<Value, Option<Vec<u8, Global>>>>::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, Seed> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Seed, <Artichoke as TryConvertMut<Value, Seed>>::Error>

Performs the fallible conversion.

impl TryConvertMut<Value, String> for Artichoke

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<String, <Artichoke as TryConvertMut<Value, String>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<&'a [u8], Global>, <Artichoke as TryConvertMut<Value, Vec<&'a [u8], Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<&'a str, Global>, <Artichoke as TryConvertMut<Value, Vec<&'a str, Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<(Value, Value), Global>, <Artichoke as TryConvertMut<Value, Vec<(Value, Value), Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<Option<&'a [u8]>, Global>, <Artichoke as TryConvertMut<Value, Vec<Option<&'a [u8]>, Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<Option<&'a str>, Global>, <Artichoke as TryConvertMut<Value, Vec<Option<&'a str>, Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<Option<String>, Global>, <Artichoke as TryConvertMut<Value, Vec<Option<String>, Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<Option<Vec<u8, Global>>, Global>, <Artichoke as TryConvertMut<Value, Vec<Option<Vec<u8, Global>>, Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<String, Global>, <Artichoke as TryConvertMut<Value, Vec<String, Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<Value, Global>, <Artichoke as TryConvertMut<Value, Vec<Value, Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<Vec<u8, Global>, Global>, <Artichoke as TryConvertMut<Value, Vec<Vec<u8, Global>, Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<i64, Global>, <Artichoke as TryConvertMut<Value, Vec<i64, Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Value
) -> Result<Vec<u8, Global>, <Artichoke as TryConvertMut<Value, Vec<u8, Global>>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<&[u8], Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<&'_ [u8], Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<&str, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<&'_ str, Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<(Vec<u8, Global>, Vec<i64, Global>), Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<(Vec<u8, Global>, Vec<i64, Global>), Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<Option<&[u8]>, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<Option<&'_ [u8]>, Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<Option<&str>, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<Option<&'_ str>, Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<Option<Vec<u8, Global>>, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<Option<Vec<u8, Global>>, Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<String, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<String, Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<Value, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<Value, Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<Vec<Option<&[u8]>, Global>, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<Vec<Option<&'_ [u8]>, Global>, Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<Vec<Option<&str>, Global>, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<Vec<Option<&'_ str>, Global>, Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<Vec<Option<Vec<u8, Global>>, Global>, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<Vec<Option<Vec<u8, Global>>, Global>, Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<Vec<u8, Global>, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<Vec<u8, Global>, Global>, Value>>::Error>

Performs the fallible conversion.

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

type Error = Error

Error type for failed conversions.

pub fn try_convert_mut(
    &mut self,
    value: Vec<i64, Global>
) -> Result<Value, <Artichoke as TryConvertMut<Vec<i64, Global>, Value>>::Error>

Performs the fallible conversion.

impl Warn for Artichoke

type Error = Error

Concrete error type for errors encountered when outputting warnings.

pub fn warn(&mut self, message: &[u8]) -> Result<(), <Artichoke as Warn>::Error>

Emit a warning message using Warning#warn.