hruby-0.3.5.1: Embed a Ruby intepreter in your Haskell program !

Safe HaskellNone
LanguageHaskell98

Foreign.Ruby.Helpers

Synopsis

Documentation

class FromRuby a where #

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.

Minimal complete definition

fromRuby

Methods

fromRuby :: RValue -> IO (Either String a) #

To define more instances, please look at the instances defined in Foreign.Ruby.Helpers.

Instances

FromRuby Double # 
FromRuby Int # 
FromRuby Integer # 
FromRuby ByteString # 
FromRuby Text # 
FromRuby Value #

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 Value type can only encode dictionnaries with keys that can be converted to strings.

FromRuby a => FromRuby [a] # 

Methods

fromRuby :: RValue -> IO (Either String [a]) #

class ToRuby a where #

Whenever you use ToRuby, don't forget to use something like freezeGC or you will get random segfaults.

Minimal complete definition

toRuby

Methods

toRuby :: a -> IO RValue #

Instances

ToRuby Double # 

Methods

toRuby :: Double -> IO RValue #

ToRuby Int # 

Methods

toRuby :: Int -> IO RValue #

ToRuby Integer # 

Methods

toRuby :: Integer -> IO RValue #

ToRuby ByteString # 

Methods

toRuby :: ByteString -> IO RValue #

ToRuby Scientific # 

Methods

toRuby :: Scientific -> IO RValue #

ToRuby Text # 

Methods

toRuby :: Text -> IO RValue #

ToRuby Value # 

Methods

toRuby :: Value -> IO RValue #

ToRuby a => ToRuby [a] # 

Methods

toRuby :: [a] -> IO RValue #

embedHaskellValue :: a -> IO RValue #

An unsafe version of the corresponding Foreign.Ruby.Safe function.

freeHaskellValue :: RValue -> IO () #

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 #

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.

safeMethodCall #

Arguments

:: String

Class name.

-> 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 #

Gives a (multiline) error friendly string representation of the last error.

setGC #

Arguments

:: Bool

Set to True to enable GC, and to False to disable it.

-> IO (Either (String, RValue) RValue) 

Sets the current GC operation. Please note that this could be modified from Ruby scripts.

startGC :: IO () #

Runs the Ruby garbage collector.

freezeGC :: IO a -> IO a #

Runs a computation with the Ruby GC disabled. Once the computation is over, GC will be re-enabled and the startGC function run.