Safe Haskell	None
Language	Haskell98

Foreign.Ruby.Helpers

Synopsis

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
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 `Value` type can only encode dictionnaries with keys that can be converted to strings.
FromRuby a => FromRuby [a] Source

class ToRuby a where Source

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

Methods

toRuby :: a -> IO RValue Source

Instances

ToRuby Double Source
ToRuby Int Source
ToRuby Integer Source
ToRuby ByteString Source
ToRuby Scientific Source
ToRuby Text Source
ToRuby Value Source
ToRuby a => ToRuby [a] Source

fromRubyIntegral :: Integral n => RValue -> IO (Either String n) Source

toRubyIntegral :: Integral n => n -> IO RValue Source

fromRubyArray :: FromRuby a => RValue -> IO (Either String [a]) Source

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.

runscript :: String -> IO (Either String ()) Source

defineGlobalClass :: String -> IO RValue Source

safeMethodCall Source

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 Source

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

setGC Source

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 () Source

Runs the Ruby garbage collector.

freezeGC :: IO a -> IO a Source

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