Interface MrubyImpl

src/mruby.rs:299–980

A `trait` used on `MrubyType` which implements mruby functionality.

/// A `trait` used on `MrubyType` which implements mruby functionality.
pub trait MrubyImpl {
    /// Adds a filename to the mruby context.
    ///
    /// # Examples
    ///
    /// ```
    /// # use mrusty::Mruby;
    /// # use mrusty::MrubyError;
    /// # use mrusty::MrubyImpl;
    /// let mruby = Mruby::new();
    /// mruby.filename("script.rb");
    ///
    /// let result = mruby.run("1.nope");
    ///
    /// match result {
    ///     Err(MrubyError::Runtime(err)) => {
    ///         assert_eq!(err, "script.rb:1: undefined method \'nope\' for 1 (NoMethodError)");
    /// },
    ///     _ => assert!(false)
    /// }
    /// ```
    #[inline]
    fn filename(&self, filename: &str);

    /// Runs mruby `script` on a state and context and returns a `Value` in an `Ok`
    /// or an `Err` containing an mruby `Exception`'s message.
    ///
    /// # Examples
    ///
    /// ```
    /// # use mrusty::Mruby;
    /// # use mrusty::MrubyImpl;
    /// let mruby = Mruby::new();
    /// let result = mruby.run("true").unwrap();
    ///
    /// assert_eq!(result.to_bool().unwrap(), true);
    /// ```
    ///
    /// ```
    /// # use mrusty::Mruby;
    /// # use mrusty::MrubyError;
    /// # use mrusty::MrubyImpl;
    /// let mruby = Mruby::new();
    /// let result = mruby.run("'' + 1");
    ///
    /// match result {
    ///     Err(MrubyError::Runtime(err)) => {
    ///         assert_eq!(err, "TypeError: expected String");
    /// },
    ///     _ => assert!(false)
    /// }
    /// ```
    #[inline]
    fn run(&self, script: &str) -> Result<Value, MrubyError>;

    /// Runs mruby `script` on a state and context and returns a `Value`. If an mruby Exception is
    /// raised, mruby will be left to handle it.
    ///