| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Foreign.Ruby.Helpers
Synopsis
- class FromRuby a where
- class ToRuby a where
- fromRubyIntegral :: Integral n => RValue -> IO (Either String n)
- toRubyIntegral :: Integral n => n -> IO RValue
- fromRubyArray :: FromRuby a => RValue -> IO (Either String [a])
- embedHaskellValue :: a -> IO RValue
- freeHaskellValue :: RValue -> IO ()
- extractHaskellValue :: RValue -> IO a
- runscript :: String -> IO (Either String ())
- defineGlobalClass :: String -> IO RValue
- safeGetClass :: String -> IO (Either (String, RValue) RValue)
- safeMethodCall :: String -> String -> [RValue] -> IO (Either (String, RValue) RValue)
- safeFunCall :: RValue -> String -> [RValue] -> IO (Either (String, RValue) RValue)
- showErrorStack :: IO String
- setGC :: Bool -> IO (Either (String, RValue) RValue)
- startGC :: IO ()
- freezeGC :: IO a -> IO a
Documentation
class FromRuby a where Source #
The class of things that can be converted from Ruby values. Note that
there are a ton of stuff that are Ruby values, hence the Maybe type,
as the instances will probably be incomplete.
Methods
fromRuby :: RValue -> IO (Either String a) Source #
To define more instances, please look at the instances defined in Foreign.Ruby.Helpers.
Instances
| FromRuby Double Source # | |
| FromRuby Int Source # | |
| FromRuby Integer Source # | |
| FromRuby ByteString Source # | |
Defined in Foreign.Ruby.Helpers | |
| FromRuby Text Source # | |
| FromRuby Value Source # | This is the most complete instance that is provided in this module.
Please note that it is far from being sufficient for even basic
requirements. For example, the |
| FromRuby a => FromRuby [a] Source # | |
Whenever you use ToRuby, don't forget to use something like
freezeGC or you will get random segfaults.
embedHaskellValue :: a -> IO RValue Source #
An unsafe version of the corresponding Foreign.Ruby.Safe function.
freeHaskellValue :: RValue -> IO () Source #
Frees the Haskell value represented by the corresponding RValue.
This is probably extremely unsafe to do, and will most certainly lead to
exploitable security bug if you use something modified from Ruby land.
You should always free the RValue you generated from
embedHaskellValue.
extractHaskellValue :: RValue -> IO a Source #
This is unsafe as hell, so you'd better be certain this RValue has not been tempered with : GC frozen, bugfree Ruby scripts.
If it has been tempered by an attacker, you are probably looking at a good vector for arbitrary code execution.
safeGetClass :: String -> IO (Either (String, RValue) RValue) Source #
Gets a Ruby class, capturing errors.
Arguments
| :: String | Name of a class or a module. |
| -> String | Method name. |
| -> [RValue] | Arguments. Please note that the maximum number of arguments is 16. |
| -> IO (Either (String, RValue) RValue) | Returns either an error message / value couple, or the value returned by the function. |
Runs a Ruby singleton method, capturing errors.
Arguments
| :: RValue | Receiver. |
| -> String | Method name. |
| -> [RValue] | Arguments. Please note that the maximum number of arguments is 16. |
| -> IO (Either (String, RValue) RValue) | Returns either an error message / value couple, or the value returned by the function. |
Runs a Ruby method, capturing errors.
showErrorStack :: IO String Source #
Gives a (multiline) error friendly string representation of the last error.