(function() { fancy.fdoc({title:"Fancy Documentation", methods:{"FutureSend#initialize:receiver:message:":{doc:"

Forward to message initialize:receiver:message:with_params:

\n\n
\n\n", args:["@actor", "@receiver", "@message"]}, "Fancy Package Specification#add_dependency:":{doc:"

Forward to message add_dependency:version:

\n\n
\n\n", args:["name"]}, "FutureSend#:value":{doc:"

Returns the value returned by performing self.\nWill block the calling Thread if self hasn't completed or failed yet.

\n\n
Return value of performing self.
\n\n", args:[]}, "String#:raise!":{doc:"

Raises a new StdError with self as the message.

\n\n
\n\n", args:[]}, "Fancy Enumerator#initialize:":{doc:"

Initializes a new Enumerator with a given collection,\nusing #each: for iteration.

\n\n
Collection to iterate over.
\n\n", args:["@collection"]}, "Fancy Enumerator#initialize:with:":{doc:"

Initializes a new Enumerator with a given collection\nand iterator selector to be used for iteration.

\n\n
Collection to iterate over.
Selector to use to iterate over collection.
\n\n", args:["@collection", "@iterator"]}, "Object#for_option:do:":{doc:"

Runs a given block if an option is in ARGV.

\n\n
\n\n", args:["op_name", "block"]}, "Fancy Enumerator#:rewind":{doc:"

Resets the enumerator to start from the collection's beginning.

\n\n
\n\n", args:[]}, "Fancy Enumerator#with:each:":{doc:"

Similar to #each: but also passing in a given object to each invocation of block.

\n\n
A Block to be called with each element in the collection and object.
Object to pass along to block with each element in the collection.
\n\n", args:["object", "block"]}, "FutureSend#:failed?":{doc:"\n\n
true if FutureSend failed, false otherwise.
\n\n", args:[]}, "FutureSend#:succeeded?":{doc:"\n\n
true if FutureSend completed without failure, false otherwise.
\n\n", args:[]}, "Fancy FDoc JSON#write:":{doc:"

Forward to message write:call:

\n\n
\n\n", args:["filename"]}, "FutureSend#:completed?":{doc:"\n\n
true if FutureSend completed (success or failure), false otherwise.
\n\n", args:[]}, "Fancy Package Specification#add_ruby_dependency:":{doc:"

Forward to message add_ruby_dependency:version:

\n\n
\n\n", args:["gem_name"]}, "FutureSend#when_done:":{doc:"

Registers block as a continuation to be called with self's value on success.

\n\n
Block to be registered as a continuation when self succeeds.
\n\n", args:["block"]}, "Fancy Enumerator#each:":{doc:"

Calls a given Block with each element in the collection this enumerator is attached to.\nUsed for iterating over the collection using this enumerator.

\n\n
Block to be called with each element in the collection (iteration).
\n\n", args:["block"]}, "Module#included:":{doc:"

Gets called when a Class or Module is included into another Class.

\n\n
Module or Class that has been included into self.
\n\n", args:["module"]}, "Object#for_options:do:":{doc:"

Runs a given block if any of the given options is in ARGV.

\n\n
\n\n", args:["op_names", "block"]}, "Fancy Enumerator#:next":{doc:"

Returns the next element in the collection this enumerator is attached to.\nIt will move the internal position forward (compared to e.g. #peek, which doesn't).

\n\n

Example:

\n\n
 a = [1,2,3]\n e = a to_enum\n e next # => 1\n e next # => 2\n e next # => 3\n e next # => raises Fancy StopIteration\n
\n\n
Next element in the collection this enumerator is attached to.
\n\n", args:[]}, "Fancy Enumerator#:ended?":{doc:"

Indicates if an enumerator has ended (no more values left).

\n\n
true if the enumerator has ended (no more values left), false otherwise.
\n\n", args:[]}, "FutureSend#:failure":{doc:"

Returns the Exception that caused self to fail, or nil, if it didn't fail.\nWill block the calling Thread if self hasn't completed or failed yet.

\n\n
Exception that caused the FutureSend to fail, or nil, if no failure.
\n\n", args:[]}, "ThreadPool#execute_synchronous:":{doc:"

Forward to message execute_synchronous:with_args:

\n\n
\n\n", args:["block"]}, "ThreadPool#execute:":{doc:"

Forward to message execute:with_args:

\n\n
\n\n", args:["block"]}, "Module#:[]":{doc:"

Returns the value of the constant with the given name in self.

\n\n
constant_name's value.
Name (String) of constant's name.
\n\n", args:["constant_name"]}, "DynamicKeyHash#:initialize":{doc:"

Forward to message initialize:

\n\n
\n\n", args:[]}, "ThreadPool#initialize:":{doc:"

Forward to message initialize:limit:

\n\n
\n\n", args:["@count"]}, "Fancy Enumerator#:peek":{doc:"

Returns the next object in the Enumerator, but doesn't move the\ninternal position forward.\nWhen the position reaches the end, a Fancy StopIteration exception is\nraised.

\n\n

Example:

\n\n
 a = [1,2,3]\n e = a to_enum\n e next p #=> 1\n e peek p #=> 2\n e peek p #=> 2\n e peek p #=> 2\n e next p #=> 2\n e next p #=> 3\n e next p #=> raises Fancy StopIteration\n
\n\n
\n\n", args:[]}}, date:"Wed Jan 25 10:57:30 +0100 2012", objects:{}, classes:{"File":{methods:{"delete:":{doc:"

Deletes a File with a given filename.

\n\n
Path to File to be deleted.
\n\n", arg:["filename"], lines:[127, 127], file:"lib/rbx/file.fy"}, "read:length:offset:":{doc:"

Reads all the contens (in ASCII mode) of a given file, length and offset\nand returns them as an Array of lines being read.

\n\n
Fixnum being the maximum length to read from the File.
String containing the path of the File to be read.
Fixnum being the offset in bytes to start reading from the File.
Contents of the File as a String.
\n\n", arg:["filename", "length", "offset"], lines:[75, 75], file:"lib/rbx/file.fy"}, "read:with:":{doc:"

Opens a File for reading and calls block with it.

\n\n
Block called with a File object to read from.
Filename of File to read from.
\n\n", arg:["filename", "block"], lines:[26, 26], file:"lib/file.fy"}, "open:modes:with:":{doc:"

Opens a File with a given filename, a modes_arr (Array) and a block.

\n\n

E.g. to open a File with read access and read all lines and print them to STDOUT:

\n\n

File open: \"foo.txt\" modes: ['read] with: |f| {

\n\n
 { f eof? } while_false: {\n   f readln println\n }\n
\n\n

}

\n\n
Block that gets called with the File object that has been opened.
Filename to open/create.
Array of symbols that describe the desired operations to perform.
\n\n", arg:["filename", "modes_arr", "block"], lines:[33, 33], file:"lib/rbx/file.fy"}, "touch:":{doc:"

Creates a new empty file with the given filename, if it doesn't already exist.

\n\n
Name of File to be created, if not already existant.
\n\n", arg:["filename"], lines:[36, 36], file:"lib/file.fy"}, "rename:to:":{doc:"

Renames a File on the filesystem.

\n\n
Path to File to rename.
Path to new filename.
\n\n", arg:["old_name", "new_name"], lines:[148, 148], file:"lib/rbx/file.fy"}, "exists?:":{doc:"

Indicates if the File with the given filename exists.

\n\n
Path to file to check for existance.
true if File exists, false otherwise.
\n\n", arg:["filename"], lines:[49, 49], file:"lib/rbx/file.fy"}, "read:length:":{doc:"

Forward to message read:length:offset:

\n\n
\n\n", arg:["filename", "length"], lines:[64, 64], file:"lib/rbx/file.fy"}, "modes_str:":{doc:"

Returns the appropriate String representation of the modes_arr.

\n\n
String that represents the File access modifiers, as used by Ruby.
Array of symbols that describe the desired operations to perform.
\n\n", arg:["modes_arr"], lines:[108, 108], file:"lib/rbx/file.fy"}, "directory?:":{doc:"

Indicates, if a given path refers to a Directory.

\n\n
Path to check if it's a Directory.
true, if the path refers to a Directory, false otherwise.
\n\n", arg:["path"], lines:[138, 138], file:"lib/rbx/file.fy"}, "write:with:":{doc:"

Opens a File for writing and calls block with it.

\n\n
Block called with a File object to write to.
Filename of File to write to.
\n\n", arg:["filename", "block"], lines:[15, 15], file:"lib/file.fy"}, "open:modes:":{doc:"

Similar to open:modes:with: but takes no Block argument to be\ncalled with the File instance.\nReturns the opened File instead and expects the caller to close it manually.

\n\n
Filename to open/create.
A File instance that represents the opened File.
Array of symbols that describe the desired operations to perform.
\n\n", arg:["filename", "modes_arr"], lines:[90, 90], file:"lib/rbx/file.fy"}, "read:":{doc:"

Reads all the contens (in ASCII mode) of a given file and returns\nthem as an Array of lines being read.

\n\n
String containing the path of the File to be read.
Contents of the File as a String.
\n\n", arg:["filename"], lines:[61, 61], file:"lib/rbx/file.fy"}}, ancestors:["File", "Enumerable", "IO", "IOMixin", "Object", "Unmarshalable", "File Constants", "Enumerable", "Object", "Kernel"], doc:"

Instances of File represent files in the filesystem of the operating\nsystem on which Fancy is running.

\n\n
\n\n", instance_methods:{":newline":{doc:"

Writes a newline character to the File.

\n\n
\n\n", arg:[], lines:[219, 219], file:"lib/rbx/file.fy"}, "write:":{doc:"

Writes a given String to a File.

\n\n
String to be written to a File.
\n\n", arg:["str"], lines:[205, 205], file:"lib/rbx/file.fy"}, "writeln:":{doc:"

Writes a given argument as a String followed by a newline into the\nFile.

\n\n
\n\n", arg:["x"], lines:[49, 49], file:"lib/file.fy"}, "println:":{doc:"

Writes a given argument as a String followed by a newline into the\nFile.

\n\n
\n\n", arg:["x"], lines:[49, 49], file:"lib/file.fy"}, "print:":{doc:"

Writes a given String to a File.

\n\n
String to be written to a File.
\n\n", arg:["str"], lines:[205, 205], file:"lib/rbx/file.fy"}, ":modes":{doc:"

Returns the File access modes Array.

\n\n
File access modes Array.
\n\n", arg:[], lines:[174, 174], file:"lib/rbx/file.fy"}, "modes:":{doc:"

Sets the File access modes Array.

\n\n
New File access modes Array.
\n\n", arg:["modes_arr"], lines:[184, 184], file:"lib/rbx/file.fy"}, ":open?":{doc:"

Indicates, if a File is opened.

\n\n
true, if File opened, false otherwise.
\n\n", arg:[], lines:[194, 194], file:"lib/rbx/file.fy"}, ":close":{doc:"

Closes an opened File.

\n\n
\n\n", arg:[], lines:[165, 165], file:"lib/rbx/file.fy"}, ":expanded_path":{doc:"

Example:

\n\n
 f = File open: \"README.txt\"\n f expanded_path # => \"/path/to/README.txt\" (when run from /path/to/)\n
\n\n
Expanded (absolute) path of self.
\n\n", arg:[], lines:[64, 64], file:"lib/file.fy"}, ":directory?":{doc:"

Indicates, if a File is a Directory.

\n\n
true, if File is a Directory, false otherwise.
\n\n", arg:[], lines:[228, 228], file:"lib/rbx/file.fy"}, "read:":{doc:"\n\n
Integer the amount of bytes to read from a File.
\n\n", arg:["bytes"], lines:[213, 213], file:"lib/rbx/file.fy"}}}, "Set":{methods:{":[]":{doc:"

Initialize a new Set with a given collection of values.

\n\n
Fancy Enumerable of values used for new Set.
\n\n", arg:["values"], lines:[78, 78], file:"lib/set.fy"}}, ancestors:["Set", "Fancy Enumerable", "Object", "Object", "Kernel"], doc:"

A simple Set data structure class.

\n\n
\n\n", instance_methods:{"initialize:":{doc:"

Initialize a new Set with a given collection of values.

\n\n
Fancy Enumerable of values to be used as values for self.
\n\n", arg:["values"], lines:[15, 15], file:"lib/set.fy"}, ":-":{doc:"\n\n
Other Set to use for creating difference Set.
Difference Set by removing all values from self that are in other.
\n\n", arg:["other"], lines:[168, 168], file:"lib/set.fy"}, ":initialize":{doc:"

Initialize a new empty Set.

\n\n
\n\n", arg:[], lines:[26, 26], file:"lib/set.fy"}, ":size":{doc:"\n\n
Amount of values in self as a Fixnum.
\n\n", arg:[], lines:[42, 42], file:"lib/set.fy"}, "remove:":{doc:"

Removes a given object from a Set, if available.

\n\n
Object to be removed from self.
\n\n", arg:["obj"], lines:[150, 150], file:"lib/set.fy"}, ":inspect":{doc:"

Returns a detailed String representation of a Set.

\n\n
\n\n", arg:[], lines:[140, 140], file:"lib/set.fy"}, ":[]":{doc:"

Indicates, if the Set includes value.

\n\n
Value to be checked for if included in self.
true if value is in self, nil otherwise.
\n\n", arg:["value"], lines:[112, 112], file:"lib/set.fy"}, ":<<":{doc:"

Insert a value into the Set.

\n\n
Value to be inserted into self.
self.
\n\n", arg:["value"], lines:[89, 89], file:"lib/set.fy"}, ":values":{doc:"\n\n
Values in self as an Array.
\n\n", arg:[], lines:[34, 34], file:"lib/set.fy"}, ":&":{doc:"\n\n
Other Set to use for creating Set.
Intersection Set containing only values that are in both self and other.
\n\n", arg:["other"], lines:[181, 181], file:"lib/set.fy"}, ":+":{doc:"\n\n
Other Set to use for creating union Set.
Union Set containing all values in both self and other.
\n\n", arg:["other"], lines:[159, 159], file:"lib/set.fy"}, ":==":{doc:"

Indicates, if two Sets are equal.

\n\n
Set to compare self against.
true, if self is equal to other, false otherwise.
\n\n", arg:["other"], lines:[68, 68], file:"lib/set.fy"}, "each:":{doc:"

Calls a given Block for each element of the Set.

\n\n
Block to be called with each value in self.
self.
\n\n", arg:["block"], lines:[123, 123], file:"lib/set.fy"}, ":empty?":{doc:"

Indicates, if a Set is empty.

\n\n
true, if Set is emty, false otherwise.
\n\n", arg:[], lines:[52, 52], file:"lib/set.fy"}, "includes?:":{doc:"

Indicates, if the Set includes value.

\n\n
Value to be checked for if included in self.
true if value in self, false otherwise.
\n\n", arg:["value"], lines:[101, 101], file:"lib/set.fy"}, ":to_s":{doc:"

Returns a String representation of a Set.

\n\n
\n\n", arg:[], lines:[132, 132], file:"lib/set.fy"}}}, "Fancy Package":{methods:{":add_to_loadpath":{doc:"

Adds the Fancy Package install dir to the loadpath so you can\neasily require: packages into your code.

\n\n
\n\n", arg:[], lines:[99, 99], file:"lib/package.fy"}, ":install_dependencies":{doc:"

Installs dependencies found in .fancypack file in the current directory.\nIf no .fancypack file is found, fails and quits.

\n\n
\n\n", arg:[], lines:[52, 52], file:"lib/package.fy"}, "uninstall:":{doc:"

Uninstalls a package with a given name (if installed).

\n\n
Name of package to uninstall.
\n\n", arg:["package_name"], lines:[62, 62], file:"lib/package.fy"}, ":list_packages":{doc:"

Lists (prints) all installed packages on this system.

\n\n
\n\n", arg:[], lines:[70, 70], file:"lib/package.fy"}, "install:version:":{doc:"

Installs a package with a given name.\nExpects package_name to be a string in the form of:\n user/repo\nWhich would get the package code from github.com/user/repo

\n\n
Name of package to install.
\n\n", arg:["package_name", "version"], lines:[43, 43], file:"lib/package.fy"}, ":package_list_file":{doc:"\n\n
Path to installed_packages.txt File on system.
\n\n", arg:[], lines:[90, 90], file:"lib/package.fy"}, ":root_dir":{doc:"\n\n
Fancy Package root install dir.
\n\n", arg:[], lines:[83, 83], file:"lib/package.fy"}, "install:":{doc:"

Forward to message install:version:

\n\n
\n\n", arg:["package_name"], lines:[33, 33], file:"lib/package.fy"}}, ancestors:["Fancy Package", "Object", "Kernel"], doc:"

The Fancy Package System.

\n\n

This class is used for installing and uninstalling fancy packages on\nthe system.

\n\n

Example:

\n\n
 $ fancy install bakkdoor/mongo.fy\n
\n\n

Will install the mongo.fy package from http://github.com/bakkdoor/mongo.fy\nin the latest released version or get the current HEAD (master\nbranch) revision.

\n\n

You can then load the package in your source file via

\n\n
 require: \"mongo.fy\"\n
\n\n
\n\n", instance_methods:{}}, "Struct":{methods:{"new:":{doc:"

Creates a new Struct class with the given slots.

\n\n
Array of slotnames the new Struct should contain.
\n\n", arg:["slots"], lines:[14, 14], file:"lib/struct.fy"}}, ancestors:["Struct", "Enumerable", "Object", "Kernel"], doc:"

Structs are light-weight classes with predefined read-writable slots.

\n\n
\n\n", instance_methods:{}}, "RespondsToProxy":{methods:{}, ancestors:["RespondsToProxy", "BasicObject", "Object", "Kernel"], doc:"

A RespondsToProxy is a Proxy that forwards any message sent to it to it's target instance variable\nonly if it responds to that message. Any messages that target doesn't respond to simply won't be sent\nand nil will be returned.

\n\n
\n\n", instance_methods:{"initialize:":{doc:"

Initializes a new RespondsToProxy for target.

\n\n
Target receiver object.
\n\n", arg:["@target"], lines:[48, 48], file:"lib/proxy.fy"}, "unknown_message:with_params:":{doc:"

Forwards all incoming message to self to @target\nonly if @target responds to them.

\n\n
Incoming message name.
Paremeters of incoming message send.
\n\n", arg:["msg", "params"], lines:[62, 62], file:"lib/proxy.fy"}}}, "Array":{methods:{"new:":{doc:"

Creates a new Array with a given size (default value is nil).

\n\n
Initial size of the Array to be created (values default to nil).
\n\n", arg:["size"], lines:[17, 17], file:"lib/array.fy"}, ":===":{doc:"

Matches an Array against another object.

\n\n
Object to match self against.
nil, if no match, matched values (in an Array) otherwise.
\n\n", arg:["object"], lines:[470, 470], file:"lib/array.fy"}, "new:with:":{doc:"

Creates a new Array with a given size and default-value.\nIf default is a Block, call that block for each element instead.

\n\n
\n\n", arg:["size", "default"], lines:[12, 12], file:"lib/rbx/array.fy"}}, ancestors:["Array", "Fancy Enumerable", "Object", "Enumerable", "Object", "Kernel"], doc:"

Array class.\nArrays are dynamically resizable containers with a constant-time\nindex-based access to members.

\n\n
\n\n", instance_methods:{":join":{doc:"

Joins all elements with the empty String.

\n\n
 [\"hello\", \"world\", \"!\"] join # => \"hello,world!\"\n
\n\n
Elements of Array joined to a String.
\n\n", arg:[], lines:[249, 249], file:"lib/array.fy"}, "remove_if:":{doc:"

Like Array remove:, but taking a condition Block.\nRemoves all elements that meet the given condition Block.

\n\n
self, with all elements removed for which condition yields true.
Block (or Callable) that indicates, if an element should be removed from self.
\n\n", arg:["condition"], lines:[305, 305], file:"lib/array.fy"}, "index:":{doc:"

Returns the index of an item (or nil, if it isn't in the Array).

\n\n
Item/Value for which the index is requested within an Array.
Index of the value passed in within the Array, or nil, if value not present.
\n\n", arg:["item"], lines:[88, 88], file:"lib/rbx/array.fy"}, ":second":{doc:"\n\n
The second element in the Array.
\n\n", arg:[], lines:[101, 101], file:"lib/array.fy"}, "select_with_index:":{doc:"

Same as #select:, just gets also called with an additional argument\nfor each element's index value.

\n\n
\n\n", arg:["block"], lines:[434, 434], file:"lib/array.fy"}, ":first":{doc:"\n\n
The first element in the Array.
\n\n", arg:[], lines:[94, 94], file:"lib/array.fy"}, "unshift:":{doc:"

Inserts a value at the front of self.

\n\n

Example:

\n\n
 a = [1,2,3]\n a unshift: 10\n a # => [10,1,2,3]\n
\n\n
Value to be added at the front of self.
self.
\n\n", arg:["value"], lines:[126, 126], file:"lib/rbx/array.fy"}, ":to_a":{doc:"\n\n
self.
\n\n", arg:[], lines:[351, 351], file:"lib/array.fy"}, "reverse_each:":{doc:"

Example:

\n\n
 [1,2,3] reverse_each: @{print}\n # prints: 321\n
\n\n
Block to be called for each element (in reverse order).
self.
\n\n", arg:["block"], lines:[157, 157], file:"lib/array.fy"}, "prepend:":{doc:"

Prepends another Array to this one.

\n\n

Example:

\n\n
 a = [1,2,3]\n a prepend: [4,5,6]\n a # => [4,5,6,1,2,3]\n
\n\n
Other Array to be prepended to self.
self
\n\n\n

\n", arg:["arr"], lines:[66, 66], file:"lib/array.fy"}, ":compact!":{doc:"

Removes all nil-value elements in place.

\n\n
self
\n\n\n

\n", arg:[], lines:[280, 280], file:"lib/array.fy"}, "indices_of:":{doc:"

Returns an Array of all indices of this item. Empty Array if item does not occur.

\n\n
 [1, 'foo, 2, 'foo] indices_of: 'foo # => [1, 3]\n
\n\n
Item/Value for which a list of indices is requested within an Array.
Array of all indices for a given value within an Array (possibly empty).
\n\n", arg:["item"], lines:[398, 398], file:"lib/array.fy"}, "at:":{doc:"

Returns the element in the Array at a given index.

\n\n
Index for value to retrieve.
Value with the given index (if available), or nil.
\n\n", arg:["idx"], lines:[62, 62], file:"lib/rbx/array.fy"}, "each:":{doc:"

Calls a given Block with each element in the Array.

\n\n
Block to be called for each element in self.
self
\n\n\n

\n", arg:["block"], lines:[145, 145], file:"lib/array.fy"}, "join:":{doc:"

Joins all elements in the Array with a given String.\n [1,2,3] join: \", \\\342\200\235 # => \\\342\200\2351, 2, 3\"

\n\n
String by which to join all elements in self into a new String.
Joined String with all elements with join_str.
\n\n", arg:["join_str"], lines:[110, 110], file:"lib/rbx/array.fy"}, "remove_at:":{doc:"

Removes an element at a given index.\nIf given an Array of indices, removes all the elements with these indices.\nReturns the deleted object if an index was given, the last deleted object for an Array given.

\n\n
\n\n", arg:["index"], lines:[50, 50], file:"lib/rbx/array.fy"}, "select!:":{doc:"

Removes all elements in place, that don't meet the condition.

\n\n
self, but changed with all elements removed that don't yield true for condition.
A condition Block (or something Callable) for selecting items from self.
\n\n", arg:["condition"], lines:[260, 260], file:"lib/array.fy"}, "values_at:":{doc:"

Returns new Array with elements at given indices.

\n\n
Array of indices.
Array of all the items with the given indices in idx_arr.
\n\n", arg:["idx_arr"], lines:[221, 221], file:"lib/array.fy"}, ":indices":{doc:"

Returns an Array of all the indices of an Array.

\n\n
 [1,2,3] indices # => [0,1,2]\n
\n\n
Array of all indices of self.
\n\n", arg:[], lines:[386, 386], file:"lib/array.fy"}, "at:put:":{doc:"

Inserts a given object at a given index (position) in the Array.

\n\n
Index to set a value for.
Value (object) to be set at the given index.
obj
\n\n\n

\n", arg:["idx", "obj"], lines:[76, 76], file:"lib/rbx/array.fy"}, ":rest":{doc:"

Returns all elements except the first one as a new Array.

\n\n
All elements in an Array after the first one.
\n\n", arg:[], lines:[124, 124], file:"lib/array.fy"}, ":println":{doc:"

Prints each element on a seperate line.

\n\n
\n\n", arg:[], lines:[315, 315], file:"lib/array.fy"}, "append:":{doc:"

Appends another Array onto this one.

\n\n

Example:

\n\n
 a = [1,2,3]\n a append: [3,4,5]\n a # => [1,2,3,3,4,5]\n
\n\n
Other Array to be appended to self.
self
\n\n\n

\n", arg:["arr"], lines:[47, 47], file:"lib/array.fy"}, "from:to:":{doc:"

Returns sub-array starting at from: and going to to:

\n\n
Start index for sub-array.
End index ofr sub-array.
\n\n", arg:["from", "to"], lines:[418, 418], file:"lib/array.fy"}, "find:":{doc:"

Returns the item, if it's in the Array or nil (if not found).

\n\n
Object / Element to find in the Array.
item if, it's found in the Array, otherwise nil.
\n\n", arg:["item"], lines:[195, 195], file:"lib/array.fy"}, "find_by:":{doc:"

Like find: but takes a block that gets called with each element to find it.

\n\n
Block to be called for each element in the Array.
The first element, for which block yields true.
\n\n", arg:["block"], lines:[210, 210], file:"lib/array.fy"}, ":to_hash":{doc:"

Returns a Hash with each key-value pair in self.

\n\n

Example:

\n\n
 [[1,2],[3,4]] to_hash  # => <[1 => 2, 3 => 4]>\n
\n\n
\n\n", arg:[], lines:[451, 451], file:"lib/array.fy"}, ":*":{doc:"

Returns a new Array that contains the elements of self num times\nin a row.

\n\n
\n\n", arg:["num"], lines:[360, 360], file:"lib/array.fy"}, "remove:":{doc:"

Removes all occurances of obj in the Array.

\n\n
Object to be removed within self.
self, with all occurances of obj removed.
\n\n", arg:["obj"], lines:[292, 292], file:"lib/array.fy"}, ":clone":{doc:"

Clones (shallow copy) the Array.

\n\n
A shallow copy of the Array.
\n\n", arg:[], lines:[27, 27], file:"lib/array.fy"}, "reject!:":{doc:"

Same as Array#reject: but doing so in-place (destructive).

\n\n
\n\n", arg:["block"], lines:[269, 269], file:"lib/array.fy"}, "[]:":{doc:"

Inserts a given object at a given index (position) in the Array.

\n\n
Index to set a value for.
Value (object) to be set at the given index.
obj
\n\n\n

\n", arg:["idx", "obj"], lines:[76, 76], file:"lib/rbx/array.fy"}, ":inspect":{doc:"

Returns a pretty-printed String representation of self.\nExample:

\n\n
 [1, 'foo, \"bar\", 42] inspect # => \"[1, 'foo, \\\"bar\\\", 42]\"\n
\n\n
Pretty-printed String representation of self.
\n\n", arg:[], lines:[337, 337], file:"lib/array.fy"}, ":[]":{doc:"

Given an Array of 2 Fixnums, it returns the sub-array between the given indices.\nIf given a single Fixnum, returns the element at that index.

\n\n
Index to get the value for or Array of 2 indices used for a sub-array.
Element(s) stored in self at index, possibly nil or an empty Array.
\n\n", arg:["index"], lines:[87, 87], file:"lib/array.fy"}, ":+":{doc:"

Returns concatenation with another Array.

\n\n
 [1,2,3] + [3,4,5] # => [1,2,3,3,4,5]\n
\n\n
Concatenation of self with another Array
\n\n", arg:["other_arr"], lines:[375, 375], file:"lib/array.fy"}, ":third":{doc:"\n\n
The third element in the Array.
\n\n", arg:[], lines:[108, 108], file:"lib/array.fy"}, ":>>":{doc:"

Returns new Array with elements of other_arr appended to these.

\n\n
Array to be appended to self.
New Array with other_arr and self appended.
\n\n", arg:["other_arr"], lines:[236, 236], file:"lib/array.fy"}, "includes?:":{doc:"

Indicates, if an Array includes a given value.

\n\n
Object to search for in self.
true, if obj is in self, false otherwise.
\n\n", arg:["obj"], lines:[27, 27], file:"lib/rbx/array.fy"}, ":fourth":{doc:"\n\n
The fourth element in the Array.
\n\n", arg:[], lines:[115, 115], file:"lib/array.fy"}, "last:":{doc:"

Returns new Array with last n elements specified.

\n\n
Number of last elements to get from an Array.
Array with up to count size of last elements in self.
\n\n", arg:["count"], lines:[98, 98], file:"lib/rbx/array.fy"}, ":to_s":{doc:"

Returns String representation of Array.

\n\n
String representation of Array.
\n\n", arg:[], lines:[326, 326], file:"lib/array.fy"}, ":=?":{doc:"

Compares two Arrays where order does not matter.

\n\n
Other Array to compare this one to.
true, if all elements of other are in self, false otherwise.
\n\n", arg:["other"], lines:[178, 178], file:"lib/array.fy"}}}, "Fixnum":{methods:{}, ancestors:["Fixnum", "Number", "Object", "ImmediateValue", "Integer", "Precision", "Numeric", "Comparable", "Object", "Kernel"], doc:"

Standard class for integer values in Fancy.

\n\n
\n\n", instance_methods:{":random":{doc:"

Returns a random number between 0 and self.

\n\n
Random number between 0 and self.
\n\n", arg:[], lines:[29, 29], file:"lib/rbx/fixnum.fy"}}}, "Directory":{methods:{"delete:":{doc:"

Deletes a directory with a given name, if it's empty.

\n\n
Path to Directory to delete.
\n\n", arg:["dirname"], lines:[45, 45], file:"lib/rbx/directory.fy"}, "list:":{doc:"

Example usage:\n Directory list: \"tests/*/.fy\" # => [\"tests/file1.fy\", \"tests/more/file2.fy\"]

\n\n
Directory pattern or name containing files to be returned as an Array.
Array of files matching directory pattern.
\n\n", arg:["pattern"], lines:[56, 56], file:"lib/rbx/directory.fy"}, "create:":{doc:"

Creates a new Directory on the filesystem, possibly throwing\nIOError Exceptions that might occur.

\n\n
Path of Directory to create.
\n\n", arg:["dirname"], lines:[15, 15], file:"lib/rbx/directory.fy"}, "exists?:":{doc:"

Indicates, if a Directory exists with a given pathname.

\n\n
Path of Directory to check for existance.
true, if Directory exists, false otherwise.
\n\n", arg:["dirname"], lines:[15, 15], file:"lib/directory.fy"}, "create!:":{doc:"

Creates a new Directory on the filesystem, ignoring any\nExceptions that might occur.\nBasically works like running mkdir -p on the shell.

\n\n
Path of Directory to create.
\n\n", arg:["dirname"], lines:[30, 30], file:"lib/rbx/directory.fy"}}, ancestors:["Directory", "Object", "Kernel"], doc:"

Instances of Directory represent directories in the filesystem of\nthe operating system, in which Fancy is being run.

\n\n
\n\n", instance_methods:{}}, "ProxyReceiver":{methods:{}, ancestors:["ProxyReceiver", "BasicObject", "Object", "Kernel"], doc:"

A ProxyReceiver is an object which proxies all message sends to it to 2 other objects.\nIt will send each message first to its proxy instance variable and then to the obj instance variable.

\n\n
\n\n", instance_methods:{"unknown_message:with_params:":{doc:"

Forwards all incoming messages to self to @proxy and then @obj.

\n\n
Incoming message name.
Paremeters of incoming message send.
\n\n", arg:["msg", "params"], lines:[26, 26], file:"lib/proxy.fy"}, "initialize:for:":{doc:"

Initializes a new ProxyReceiver with proxy for obj.

\n\n
Proxy receiver for obj.
Original receiver object.
\n\n", arg:["@proxy", "@obj"], lines:[16, 16], file:"lib/proxy.fy"}}}, "Method":{methods:{}, ancestors:["Method", "MethodMixin", "Object", "Unmarshalable", "Object", "Kernel"], doc:"

An instance of Method represents a method on a Class.\nEvery method in Fancy is an instance of the Method class.

\n\n
\n\n", instance_methods:{}}, "NameError":{methods:{}, ancestors:["NameError", "StandardError", "Exception", "Object", "Kernel"], doc:"

NameError exception class. Used within Rubinius.

\n\n
\n\n", instance_methods:{}}, "Range":{methods:{}, ancestors:["Range", "Fancy Enumerable", "Object", "Enumerable", "Object", "Kernel"], doc:"

Class of Range values. Are created by using Range literal syntax in Fancy.

\n\n

Example:

\n\n
 (10..100) # Range from 10 to 100\n # the following code does the same as above:\n Range new: 10 to: 100\n
\n\n
\n\n", instance_methods:{"each:":{doc:"

Calls block on each value in self. Used for iterating over a Range.

\n\n
Block to be called with every value in self.
self.
\n\n", arg:["block"], lines:[36, 36], file:"lib/rbx/range.fy"}, ":to_s":{doc:"

Same as Range#inspect

\n\n
\n\n", arg:[], lines:[18, 18], file:"lib/range.fy"}, "initialize:to:":{doc:"

Initializes a new Range starting at start and ending at end.

\n\n
End element of Range.
Start element of Range.
\n\n", arg:["@start", "@end"], lines:[13, 13], file:"lib/rbx/range.fy"}, ":inspect":{doc:"\n\n
String representation of self.
\n\n", arg:[], lines:[26, 26], file:"lib/range.fy"}}}, "Fancy Enumerable":{methods:{}, ancestors:["Fancy Enumerable", "Object", "Kernel"], doc:"

Mixin-Class with useful methods for collections that implement an each: method.

\n\n
\n\n", instance_methods:{"superior_by:taking:":{doc:"

Returns the superior element in the Enumerable that has met\nthe given comparison block with all other elements,\napplied to whatever selection_block returns for each element.

\n\n

Examples:

\n\n
 [1,2,5,3,4] superior_by: '> # => 5\n [1,2,5,3,4] superior_by: '< # => 1\n [[1,2], [2,3,4], [], [1]] superior_by: '> taking: 'size # => [2,3,4]\n [[1,2], [2,3,4], [-1]] superior_by: '< taking: 'first # => [-1]\n
\n\n
Block to be used for comparison.
defaults to identity.
Superior element in self in terms of comparison_block.
\n\n", arg:["comparison_block", "selection_block"], lines:[388, 388], file:"lib/enumerable.fy"}, ":first":{doc:"\n\n
First element in self or nil, if empty.
\n\n", arg:[], lines:[339, 339], file:"lib/enumerable.fy"}, "sort_by:":{doc:"

Sorts a collection by a given comparison block.

\n\n
Block taking 2 arguments used to compare elements in a collection.
Sorted Array of elements in self.
\n\n", arg:["block"], lines:[496, 496], file:"lib/enumerable.fy"}, "reverse_each:":{doc:"

Runs block for each element on reversed version of self.\nIf self is not a sorted collection, no guarantees about the reverse order can be given.

\n\n
Block to be called for each element in reverse order.
self
\n\n\n

\n", arg:["block"], lines:[568, 568], file:"lib/enumerable.fy"}, "inject:into:":{doc:"

Same as reduce:init_val: but taking the initial value as first\nand the reducing block as second parameter.

\n\n

Example:

\n\n
 [1,2,3] inject: 0 into: |sum val| { sum + val } # => 6\n
\n\n
\n\n", arg:["val", "block"], lines:[286, 286], file:"lib/enumerable.fy"}, "partition_by:":{doc:"

Example:

\n\n
 0 upto: 10 . partition_by: |x| { x < 3 }  # => [[0, 1, 2], [3, 4, 5, 6, 7, 8, 9, 10]]\n
\n\n
Block that gets used to decide when to partition elements in self.
Array of Arrays, partitioned by equal return values of calling block with each element
\n\n", arg:["block"], lines:[456, 456], file:"lib/enumerable.fy"}, "each:in_between:":{doc:"

Similar to each: but calls an additional Block between\ncalling the first Block for each element in self.

\n\n
\n\n", arg:["each_block", "between_block"], lines:[40, 40], file:"lib/enumerable.fy"}, ":max":{doc:"

Returns the maximum value in the Enumerable (via the '>' comparison message).

\n\n
Maximum value in self.
\n\n", arg:[], lines:[409, 409], file:"lib/enumerable.fy"}, "map:":{doc:"

Returns a new Array with the results of calling a given block for every element.

\n\n
A Block that gets called with each element in self.
An Array containing all values of calling block with each element in self.
\n\n", arg:["block"], lines:[140, 140], file:"lib/enumerable.fy"}, ":last":{doc:"

Returns the last element in an Enumerable.

\n\n
Last element in self or nil, if empty.
\n\n", arg:[], lines:[349, 349], file:"lib/enumerable.fy"}, ":uniq":{doc:"

Returns a new Array with all unique values (double entries are skipped).

\n\n

Example:

\n\n
 [1,2,1,2,3] uniq # => [1,2,3]\n
\n\n
Array of all unique elements in self.
\n\n", arg:[], lines:[298, 298], file:"lib/enumerable.fy"}, "take_while:":{doc:"

Returns a new Array by taking elements from the beginning\nas long as they meet the given condition block.

\n\n

Example:

\n\n
 [1,2,3,4,5] take_while: |x| { x < 4 } # => [1,2,3]\n
\n\n
An Array of all elements from the beginning until condition yields false.
A Block that is used as a condition for filtering.
\n\n", arg:["condition"], lines:[187, 187], file:"lib/enumerable.fy"}, ":product":{doc:"

Calculates the product of all the elements in the Enumerable\n(assuming them to be Numbers (implementing + & *)).

\n\n
\n\n", arg:[], lines:[437, 437], file:"lib/enumerable.fy"}, "reject:":{doc:"

Similar to select: but inverse.\nReturns a new Array with all elements that don't meet the given condition block.

\n\n
\n\n", arg:["condition"], lines:[168, 168], file:"lib/enumerable.fy"}, "in_groups_of:":{doc:"

Example usage:

\n\n
 [1,2,3,4,5] in_groups_of: 3 # => [[1,2,3],[4,5]]\n
\n\n
Array of Arrays with a max size of size (grouped).
Maximum size of each group.
\n\n", arg:["size"], lines:[507, 507], file:"lib/enumerable.fy"}, "join:":{doc:"

Joins a collection with a String between each element, returning a new String.

\n\n
 \"hello, world\" join: \"-\" # => \"h-e-l-l-o-,- -w-o-r-l-d\"\n
\n\n
Value (usually a String) to be used for the joined String.
String containing all elements in self interspersed with str.
\n\n", arg:["str"], lines:[57, 57], file:"lib/enumerable.fy"}, ":empty?":{doc:"

Indicates, if the Enumerable is empty (has no elements).

\n\n
true, if size of self is 0, false otherwise.
\n\n", arg:[], lines:[328, 328], file:"lib/enumerable.fy"}, ":compact":{doc:"

Returns a new Array with all values removed that are nil ( return true on nil? ).

\n\n

Example:

\n\n
 [1,2,nil,3,nil] compact # => [1,2,3]\n
\n\n
Array with all non-nil elements in self.
\n\n", arg:[], lines:[367, 367], file:"lib/enumerable.fy"}, ":reverse":{doc:"

Returns self in reverse order.\nThis only makes sense for collections that have an ordering.\nIn either case, it simply converts self to an Array and returns it in reversed order.

\n\n
self in reverse order.
\n\n", arg:[], lines:[537, 537], file:"lib/enumerable.fy"}, "superior_by:":{doc:"

Forward to message superior_by:taking:

\n\n
\n\n", arg:["comparison_block"], lines:[369, 369], file:"lib/enumerable.fy"}, ":average":{doc:"\n\n
Average value in self (expecting Numbers or Objects implementing + and *).
\n\n", arg:[], lines:[444, 444], file:"lib/enumerable.fy"}, "all?:":{doc:"

Takes condition-block and returns true if all elements meet it.

\n\n
Predicate Block to be called for each element until it returns false for any one of them.
true if all elements in self yield true for block, false otherwise.
\n\n", arg:["condition"], lines:[95, 95], file:"lib/enumerable.fy"}, "find:":{doc:"

Returns nil, if item (or anything that returns true when comparing to item) isn't found.\nOtherwise returns that element that is equal to item.

\n\n
Item to be found in self.
The first element that is equal to item or nil, if none found.
\n\n", arg:["item"], lines:[117, 117], file:"lib/enumerable.fy"}, "find_by:":{doc:"

Similar to find: but takes a block that is called for each element to find it.

\n\n
\n\n", arg:["block"], lines:[129, 129], file:"lib/enumerable.fy"}, "drop:":{doc:"

Example:

\n\n
 [1,2,3,4,5] drop: 2 # => [3,4,5]\n
\n\n
Amount of elements to skip in self.
An Array of all but the first amount elements in self.
\n\n", arg:["amount"], lines:[251, 251], file:"lib/enumerable.fy"}, ":size":{doc:"

Returns the size of an Enumerable.

\n\n
Amount of elements in self.
\n\n", arg:[], lines:[314, 314], file:"lib/enumerable.fy"}, "any?:":{doc:"

Indicates, if any element meets the condition.

\n\n
true, if condition yields true for any element, false otherwise.
Block (or Callable) that is used to check if any element in self yields true for it.
\n\n", arg:["condition"], lines:[79, 79], file:"lib/enumerable.fy"}, "take:":{doc:"

Example:

\n\n
 [1,2,3,4] take: 2 # => [1,2]\n
\n\n
Amount of elements to take from self.
First amount elements of self in an Array.
\n\n", arg:["amount"], lines:[235, 235], file:"lib/enumerable.fy"}, "drop_while:":{doc:"

Similar to take_while: but inverse.\nReturns a new Array by skipping elements from the beginning\nas long as they meet the given condition block.

\n\n

Example:

\n\n
 [1,2,3,4,5] drop_while: |x| { x < 4 } # => [4,5]\n
\n\n
\n\n", arg:["condition"], lines:[208, 208], file:"lib/enumerable.fy"}, "skip:":{doc:"

Example:

\n\n
 [1,2,3,4,5] drop: 2 # => [3,4,5]\n
\n\n
Amount of elements to skip in self.
An Array of all but the first amount elements in self.
\n\n", arg:["amount"], lines:[251, 251], file:"lib/enumerable.fy"}, ":sum":{doc:"

Calculates the sum of all the elements in the Enumerable\n(assuming them to be Numbers (implementing '+' & '*')).

\n\n
\n\n", arg:[], lines:[428, 428], file:"lib/enumerable.fy"}, "select:":{doc:"

Returns a new Array with all elements that meet the given condition block.

\n\n
An Array containing all elements in self that yield true when called with condition.
A Block that is used as a filter on all elements in self.
\n\n", arg:["condition"], lines:[155, 155], file:"lib/enumerable.fy"}, "to_hash:":{doc:"

Example:

\n\n
   [\"foo\", \\\342\200\235hello\", \"ok\", \"\"] to_hash: @{ size }\n   # => <[3 => \"foo\", 5 => \"hello\", 2 => \"ok\", 0 => \"\"]>\n
\n\n
Block to be called to get the key for each element in self.
Hash of key/value pairs based on values in self.
\n\n", arg:["block"], lines:[551, 551], file:"lib/enumerable.fy"}, "each_with_index:":{doc:"

Iterate over all elements in self.\nCalls a given Block with each element and its index.

\n\n
Block to be called with each element and its index in the self.
self
\n\n\n

\n", arg:["block"], lines:[16, 16], file:"lib/enumerable.fy"}, "includes?:":{doc:"

Indicates, if a collection includes a given element.

\n\n
Item to check if it's included in self.
true, if item in self, otherwise false.
\n\n", arg:["item"], lines:[32, 32], file:"lib/enumerable.fy"}, "reduce:init_val:":{doc:"

Calculates a value based on a given block to be called on an accumulator\nvalue and an initial value.

\n\n

Example:

\n\n
 [1,2,3] reduce: |sum val| { sum + val } init_val: 0 # => 6\n
\n\n
\n\n", arg:["block", "init_val"], lines:[269, 269], file:"lib/enumerable.fy"}, ":random":{doc:"\n\n
Random element in self.
\n\n", arg:[], lines:[479, 479], file:"lib/enumerable.fy"}, ":min":{doc:"

Returns the minimum value in the Enumerable (via the '<' comparison message).

\n\n
Minimum value in self.
\n\n", arg:[], lines:[419, 419], file:"lib/enumerable.fy"}}}, "Thread":{methods:{"sleep:":{doc:"

Sets the Fancy process for a given amount of seconds to sleep.

\n\n
\n\n", arg:["seconds"], lines:[87, 87], file:"lib/rbx/thread.fy"}}, ancestors:["Thread", "Object", "Kernel"], doc:"

Thread class.\nDeals with parallel execution.

\n\n

TODO:\n=> Still need to add more Fancy-ish wrapper methods and method\n documentation.

\n\n
\n\n", instance_methods:{}}, "Bignum":{methods:{}, ancestors:["Bignum", "Number", "Object", "Integer", "Precision", "Numeric", "Comparable", "Object", "Kernel"], doc:"

Class for large integer values in Fancy.

\n\n
\n\n", instance_methods:{}}, "NilClass":{methods:{":new":{doc:"\n\n
nil.
\n\n", arg:[], lines:[13, 13], file:"lib/nil_class.fy"}}, ancestors:["NilClass", "ImmediateValue", "Object", "Kernel"], doc:"

NilClass. The class of the singleton nil value.

\n\n
\n\n", instance_methods:{"if_nil:":{doc:"

Calls block with self.

\n\n
Block to be called.
Value of calling block with self.
\n\n", arg:["block"], lines:[41, 41], file:"lib/nil_class.fy"}, "if_nil:else:":{doc:"

Calls then_block with self.

\n\n
Block to be called with self.
Gets ignored.
Value of calling then_block with self.
\n\n", arg:["then_block", "else_block"], lines:[53, 53], file:"lib/nil_class.fy"}, ":nil?":{doc:"\n\n
true.
\n\n", arg:[], lines:[61, 61], file:"lib/nil_class.fy"}, ":not":{doc:"\n\n
true.
\n\n", arg:[], lines:[87, 87], file:"lib/nil_class.fy"}, "if_true:":{doc:"\n\n
nil.
\n\n", arg:["block"], lines:[21, 21], file:"lib/nil_class.fy"}, "if_true:else:":{doc:"

Calls else_block.

\n\n
Value of calling else_block.
\n\n", arg:["then_block", "else_block"], lines:[30, 30], file:"lib/nil_class.fy"}, ":to_a":{doc:"\n\n
An empty Array.
\n\n", arg:[], lines:[79, 79], file:"lib/nil_class.fy"}, ":to_s":{doc:"\n\n
An empty String.
\n\n", arg:[], lines:[69, 69], file:"lib/nil_class.fy"}, ":inspect":{doc:"\n\n
nil as a String.
\n\n", arg:[], lines:[95, 95], file:"lib/nil_class.fy"}}}, "Fancy Package Uninstaller":{methods:{}, ancestors:["Fancy Package Uninstaller", "Object", "Kernel"], doc:"

Fancy Package Uninstaller.

\n\n
\n\n", instance_methods:{}}, "MatchData":{methods:{}, ancestors:["MatchData", "Unmarshalable", "Object", "Kernel"], doc:"

MatchData instances are created when using the #=== match operator\n(e.g. by using match/case expressions).

\n\n
\n\n", instance_methods:{"at:":{doc:"\n\n
Index of value to get.
Value at index idx.
\n\n", arg:["idx"], lines:[16, 16], file:"lib/rbx/match_data.fy"}, ":to_a":{doc:"\n\n
Array representation of self containing matched values of self.
\n\n", arg:[], lines:[24, 24], file:"lib/rbx/match_data.fy"}}}, "Regexp":{methods:{}, ancestors:["Regexp", "Object", "Kernel"], doc:"

Regular Expression class. Used by Regexp literals in Fancy.

\n\n
\n\n", instance_methods:{}}, "TCPSocket":{methods:{"open:port:":{doc:"

Creates and opens a new TCPSocket on server and port.

\n\n
Server hostname to open Socket on.
Server port to open Socket on.
\n\n", arg:["server", "port"], lines:[19, 19], file:"lib/rbx/tcp_socket.fy"}}, ancestors:["TCPSocket", "IPSocket", "BasicSocket", "IO", "IOMixin", "Object", "Unmarshalable", "File Constants", "Enumerable", "Object", "Kernel"], doc:"

TCP Socket class.

\n\n
\n\n", instance_methods:{"send:":{doc:"

Forward to message send:flags:

\n\n
\n\n", arg:["msg"], lines:[21, 21], file:"lib/rbx/tcp_socket.fy"}}}, "Date":{methods:{}, ancestors:["Date", "Comparable", "Object", "Kernel"], doc:"

Date class. Used for timely stuff.

\n\n
\n\n", instance_methods:{":!=":{doc:"\n\n
Other Date to compare to.
true if equal, false otherwhise.
\n\n", arg:["other"], lines:[20, 20], file:"lib/rbx/date.fy"}}}, "Fancy Documentation":{methods:{"for:append:":{doc:"

Append docstring to the documentation for obj.\nIf obj has no documentation, one is created for it.

\n\n
\n\n", arg:["obj", "docstring"], lines:[70, 70], file:"lib/documentation.fy"}, "for_method:on_class:is:":{doc:"

Similar to Fancy Documentation but taking the method name and the Class for which Method to define the docstring.

\n\n
\n\n", arg:["method_name", "class", "docstring"], lines:[49, 49], file:"lib/rbx/documentation.fy"}, "remove:":{doc:"

Removes the documentation for obj.

\n\n
\n\n", arg:["obj"], lines:[62, 62], file:"lib/rbx/documentation.fy"}, "formatter:is:":{doc:"

Registers a callable object as formatter under name.

\n\n
\n\n", arg:["name", "callable"], lines:[91, 91], file:"lib/documentation.fy"}, ":formatters":{doc:"

Obtain the hash of known documentation formatters.

\n\n
\n\n", arg:[], lines:[100, 100], file:"lib/documentation.fy"}, "for:is:":{doc:"

Create a Fancy::Documentation instance.

\n\n

Note: As we're bootstrapping, we cannot set documentation here as\nan string literal.

\n\n

We are the very first thing to load, so just create a new\nFancy::Documentation object without using new:, and set it as\nfancy docs.

\n\n
\n\n", arg:["obj", "docstring"], lines:[37, 37], file:"lib/rbx/documentation.fy"}, "for:":{doc:"

Obtains the Fancy Documentation for obj.

\n\n
\n\n", arg:["obj"], lines:[57, 57], file:"lib/rbx/documentation.fy"}, "formatter:":{doc:"

Obtains a formatter by a given name. Returns a callable object.

\n\n
\n\n", arg:["name"], lines:[83, 83], file:"lib/documentation.fy"}}, ancestors:["Fancy Documentation", "Object", "Kernel"], doc:"

A Fancy Documentation object is a holder for docstrings and specs.\nKeeps a registry of documentation for anything Fancy.

\n\n

Provides methods for searching and formatting an Object's docstrings.\nThis can be be handy for users of the interactive Fancy REPL,\ndocument generators, instrospection tools, IDEs, anything!

\n\n

This object can be converted to just anything by using its format:\nmethod. Formatters can be registered with Fancy Documentation#formatter:is:

\n\n

By default two formatters are defined:

\n\n

'fancy => Returns the Fancy::Documentation object\n 'string => Returns the docs string representation

\n\n
\n\n", instance_methods:{"format:":{doc:"

If format is specified, the documentation string will be\nconverted using the corresponding formatter. This allows\nyou to extend Fancy documentation system, and produce\nhtml documents, man pages, or anything you can imagine.

\n\n
\n\n", arg:["format"], lines:[58, 58], file:"lib/documentation.fy"}, ":docs":{doc:"

An array of docstrings for the object beind documented.

\n\n

We have an array of docstrings because in Fancy, some\nthings like classes can be re-openned and the user may\nspecify new documentation for it each time. Thus we dont\nwant to loose the previous documentation but rather build\nupon it. That is, fancy supports incremental documentation.

\n\n
\n\n"}, ":specs":{doc:"

An array of associated Fancy specs for the object\nbeing documented.

\n\n

Its a lot better to keep the associated specs in\nFancy Documentation objects instead of just having them\nin method instances. This allows us to associate any object\nwith an spec example.

\n\n

This way you can have a single Fancy spec example that\nis related to many objects (methods, constants, classes)\nthat are being specified. Later in documentation, we can\nprovide links to all specs where an object is being exercised.

\n\n
\n\n"}}}, "TrueClass":{methods:{":new":{doc:"\n\n
true.
\n\n", arg:[], lines:[13, 13], file:"lib/true_class.fy"}}, ancestors:["TrueClass", "ImmediateValue", "Object", "Kernel"], doc:"

TrueClass. The class of the singleton true value.

\n\n
\n\n", instance_methods:{":not":{doc:"\n\n
false.
\n\n", arg:[], lines:[70, 70], file:"lib/true_class.fy"}, "if_true:":{doc:"

Calls block with self.

\n\n
Block to be called with self.
Value of calling block with self.
\n\n", arg:["block"], lines:[24, 24], file:"lib/true_class.fy"}, "if_true:else:":{doc:"

Calls then_block with self.

\n\n
Block to be called with self.
Gets ignored.
Value of calling then_block with self.
\n\n", arg:["then_block", "else_block"], lines:[36, 36], file:"lib/true_class.fy"}, ":true?":{doc:"\n\n
true.
\n\n", arg:[], lines:[44, 44], file:"lib/true_class.fy"}, ":to_a":{doc:"\n\n
An empty Array.
\n\n", arg:[], lines:[62, 62], file:"lib/true_class.fy"}, ":to_s":{doc:"\n\n
true as a String.
\n\n", arg:[], lines:[52, 52], file:"lib/true_class.fy"}, ":inspect":{doc:"\n\n
true as a String.
\n\n", arg:[], lines:[52, 52], file:"lib/true_class.fy"}}}, "Console":{methods:{":newline":{doc:"

Prints a newline to STDOUT.

\n\n
\n\n", arg:[], lines:[7, 7], file:"lib/rbx/console.fy"}, "println:":{doc:"

Prints a given object on STDOUT, followed by a newline.

\n\n
Object to be printed on STDOUT, followed by a newline.
\n\n", arg:["obj"], lines:[27, 27], file:"lib/rbx/console.fy"}, ":readln":{doc:"

Reads a line from STDIN and returns it as a String.

\n\n
Line (String) read from STDIN.
\n\n", arg:[], lines:[56, 56], file:"lib/rbx/console.fy"}, "print:":{doc:"

Prints a given object on STDOUT.

\n\n
Object to be printed on STDOUT.
\n\n", arg:["obj"], lines:[17, 17], file:"lib/rbx/console.fy"}, ":clear":{doc:"

Clears the Console.

\n\n
\n\n", arg:[], lines:[61, 61], file:"lib/rbx/console.fy"}, "readln:":{doc:"

Prints a given message to STDOUT, followed by reading a line from\nSTDIN.

\n\n
A String that should be printed to STDOUT before reading from STDIN.
Line (String) read from STDIN.
\n\n", arg:["message"], lines:[40, 40], file:"lib/rbx/console.fy"}}, ancestors:["Console", "Object", "Kernel"], doc:"

Console class. Used for STDIO.

\n\n
\n\n", instance_methods:{}}, "Tuple":{methods:{"new:":{doc:"

Initializes a new Tuple with a given amount of element slots.\nE.g. if size is 2, creates a 2-Tuple.

\n\n
Size of the Tuple (amount of values to hold).
\n\n", arg:["size"], lines:[16, 16], file:"lib/rbx/tuple.fy"}, "with_values:":{doc:"

Creates a new Tuple with the values passed in.

\n\n

Example:

\n\n
 Tuple with_values: [1,2,3] # => (1,2,3)\n
\n\n
Values of the Tuple to be created.
\n\n", arg:["values"], lines:[19, 19], file:"lib/tuple.fy"}, ":===":{doc:"

Matches Tuple class against an object.\nIf the given object is a Tuple instance, return a Tuple object.

\n\n
Object to be matched against
Tuple instance containing the values of obj to be used in pattern matching.
\n\n", arg:["obj"], lines:[144, 144], file:"lib/tuple.fy"}}, ancestors:["Rubinius Tuple", "Fancy Enumerable", "Object", "Enumerable", "Object", "Kernel"], doc:"

Tuples are fixed-size containers providing index-based access to its\nelements.

\n\n
\n\n", instance_methods:{":second":{doc:"\n\n
The second element in self.
\n\n", arg:[], lines:[48, 48], file:"lib/tuple.fy"}, "at:":{doc:"

Returns an element at a given indes.\nPossibly throws an Rubinius ObjectBoundsExceededError.

\n\n
Index for the element to get.
Element at the given index within the Tuple or nil.
\n\n", arg:["idx"], lines:[34, 34], file:"lib/rbx/tuple.fy"}, ":third":{doc:"\n\n
The third element in self.
\n\n", arg:[], lines:[56, 56], file:"lib/tuple.fy"}, ":==":{doc:"

Compares two Tuples with each other.

\n\n
Other Tuple to compare self with.
true, if tuples are equal element-wise, false otherwise.
\n\n", arg:["other"], lines:[114, 114], file:"lib/tuple.fy"}, "each:":{doc:"

Calls a given Block with each element in the Tuple.

\n\n
Block to be called for each element in self.
Return value of calling block on the last item in self.
\n\n", arg:["block"], lines:[74, 74], file:"lib/tuple.fy"}, ":first":{doc:"\n\n
The first element in self.
\n\n", arg:[], lines:[40, 40], file:"lib/tuple.fy"}, ":fourth":{doc:"\n\n
The fourth element in self.
\n\n", arg:[], lines:[64, 64], file:"lib/tuple.fy"}, "reverse_each:":{doc:"

Example:

\n\n
 (1,2,3) reverse_each: @{print}\n # prints: 321\n
\n\n
Block to be called for each element (in reverse order).
self.
\n\n", arg:["block"], lines:[90, 90], file:"lib/tuple.fy"}, "at:put:":{doc:"

Sets a value for a given index within a Tuple.

\n\n
Index of element to set.
Value to set at given index.
\n\n", arg:["idx", "val"], lines:[44, 44], file:"lib/rbx/tuple.fy"}, "[]:":{doc:"

Sets a value for a given index within a Tuple.

\n\n
Index of element to set.
Value to set at given index.
\n\n", arg:["idx", "val"], lines:[44, 44], file:"lib/rbx/tuple.fy"}, ":inspect":{doc:"\n\n
A String representation of self.
\n\n", arg:[], lines:[122, 122], file:"lib/tuple.fy"}, ":[]":{doc:"

Forwards to Tuple#at:.

\n\n
\n\n", arg:["idx"], lines:[32, 32], file:"lib/tuple.fy"}}}, "Exception":{methods:{}, ancestors:["Exception", "Object", "Kernel"], doc:"

Base Exception class.\nAll Exception classes inherit from Exception.

\n\n
\n\n", instance_methods:{}}, "NoMethodError":{methods:{}, ancestors:["NoMethodError", "NameError", "StandardError", "Exception", "Object", "Kernel"], doc:"

Exception class that gets thrown when a method wasn't found within a class.

\n\n
\n\n", instance_methods:{":method_name":{doc:"

Returns the name of the method that was not found as a String.

\n\n
Name of the method not found (as String).
\n\n", arg:[], lines:[13, 13], file:"lib/rbx/no_method_error.fy"}}}, "Fancy BreakIteration":{methods:{}, ancestors:["Fancy BreakIteration", "StandardError", "Exception", "Object", "Kernel"], doc:"

Raised to break the current iteration.\nIt is rescued by Block#loop.

\n\n

Example:

\n\n
 10 times: |i| {\n     i println\n     if: (i == 3) then: {\n       Fancy BreakIteration new raise!\n     }\n }\n \"Done!\" println\n
\n\n

Produces:

\n\n
 0\n 1\n 2\n 3\n Done!\n
\n\n
\n\n", instance_methods:{}}, "Actor":{methods:{"spawn:":{doc:"

Example usage:

\n\n
 Actor spawn: {\n   loop: {\n     Actor receive println # print all incoming messages\n   }\n }\n
\n\n
Block that represents the Actor's code body to be executed in a new Thread.
A new Actor running block in a seperate Thread.
\n\n", arg:["block"], lines:[51, 51], file:"lib/rbx/actor.fy"}}, ancestors:["Actor", "Object", "Kernel"], doc:"

Primitive Actor class.\nActors can be sent messages asynchronously. They process incoming messages\n(which can be any object, including Tuples, Arrays, Numbers ...) in a\nfirst-come, first-serve manner.

\n\n

Actors are used to implement asynchronous and future message sends in Fancy\nusing the @ and @@ syntax.

\n\n

Example usage:

\n\n

a = Actor spawn: {

\n\n
 loop: {\n   match Actor receive {\n     case 'hello -> \"Hello World\" println\n     case 'quit ->\n       \"OK, done!\" println\n       break # Quit loop and let actor die\n   }\n }\n
\n\n

}

\n\n

10 times: {

\n\n
 a ! 'hello # send 'hello to actor asynchronously\n
\n\n

}\n a ! 'quit

\n\n
\n\n", instance_methods:{}}, "String":{methods:{}, ancestors:["String", "Fancy Enumerable", "Object", "Enumerable", "Comparable", "Object", "Kernel"], doc:"

Strings are sequences of characters and behave as such.\nAll literal Strings within Fancy code are instances of the String\nclass.

\n\n

They also include Fancy Enumerable, which means you can use all the\ncommon sequence methods on them, like +map:+, +select:+ etc.

\n\n
\n\n", instance_methods:{":lines":{doc:"

Returns the lines of a String as an Array.

\n\n
Array of all the lines in self.
\n\n", arg:[], lines:[123, 123], file:"lib/string.fy"}, ":eval":{doc:"

Evaluates a String in the current Binding and returns its value.

\n\n
Value of evaluating self as Fancy code.
\n\n", arg:[], lines:[85, 85], file:"lib/rbx/string.fy"}, "==":{doc:"

Compares self to another String and returns true, if equal, false otherwise.

\n\n
\n\n", lines:[139, 139], file:"kernel/common/string.rb"}, ":characters":{doc:"\n\n
Array of all characters (as String) in self.
\n\n", arg:[], lines:[165, 165], file:"lib/string.fy"}, ":words":{doc:"

Example:

\n\n
 \"hello world\" words  # => [\"hello\", \"world\"]\n
\n\n
Array of all the whitespace seperated words in self.
\n\n", arg:[], lines:[93, 93], file:"lib/string.fy"}, ":==":{doc:"

Compares self to another String and returns true, if equal, false otherwise.

\n\n
\n\n", lines:[139, 139], file:"kernel/common/string.rb"}, "at:":{doc:"

Returns the character (as a String) at index idx.

\n\n
Index of the character to retrieve.
Character in self at position idx.
\n\n", arg:["idx"], lines:[59, 59], file:"lib/rbx/string.fy"}, "each:":{doc:"

Calls a given Block with each character in a String.

\n\n
Block to be called for each character in self.
\n\n", arg:["block"], lines:[49, 49], file:"lib/rbx/string.fy"}, ":character":{doc:"\n\n
Fixnum (byte / ASCII) value of first character in self.
\n\n", arg:[], lines:[172, 172], file:"lib/string.fy"}, "split:":{doc:"\n\n
String where self should be split at.
An Array of String values in self that are seperated by str.
\n\n", arg:["str"], lines:[68, 68], file:"lib/rbx/string.fy"}, ":split":{doc:"

Splits a string by whitespace.

\n\n
Array of all non-whitespace Substrings in self.
\n\n", arg:[], lines:[77, 77], file:"lib/rbx/string.fy"}, ":lowercase":{doc:"

Example:

\n\n
 \"HELLO WORLD\" lowercase # => \"hello world\"\n
\n\n
Lowercased version of self.
\n\n", lines:[580, 580], file:"kernel/common/string.rb"}, ":rest":{doc:"

Returns a String containing all but the first character.

\n\n
 \"hello\" rest # => \"ello\"\n
\n\n
String containing all but the first character.
\n\n", arg:[], lines:[113, 113], file:"lib/string.fy"}, ":raise!":{doc:"

Raises a new StandardError with self as the message.

\n\n
\n\n", arg:[], lines:[101, 101], file:"lib/string.fy"}, ":uppercase":{doc:"

Example:

\n\n
 \"hello world\" uppercase # => \"HELLO WORLD\"\n
\n\n
Uppercased version of self.
\n\n", lines:[1549, 1549], file:"kernel/common/string.rb"}, "append:":{doc:"

Appends another String onto this String.

\n\n

Example usage:\n str = \"hello\"\n str append: \" world!\"\n str # => \"hello world!\"

\n\n
Other String to append on self.
self, but modified.
\n\n", arg:["string"], lines:[143, 143], file:"lib/rbx/string.fy"}, "from:to:":{doc:"

Returns a Substring from from to to.

\n\n
Start index.
End index.
Substring starting at index from and ending at to.
\n\n", arg:["from", "to"], lines:[41, 41], file:"lib/rbx/string.fy"}, ":blank?":{doc:"

Indicates, if a String consists only of whitespace.

\n\n
true if self consists only of whitespace, false otherwise.
\n\n", arg:[], lines:[60, 60], file:"lib/string.fy"}, "downcase":{doc:"

Example:

\n\n
 \"HELLO WORLD\" lowercase # => \"hello world\"\n
\n\n
Lowercased version of self.
\n\n", lines:[580, 580], file:"kernel/common/string.rb"}, ":*":{doc:"

Returns a String that is the num-fold concatenation of itself.

\n\n

Example:

\n\n
 \"foo\" * 3 # => \"foofoofoo\"\n
\n\n
Amount of concatenations to do with self.
String that is the num-fold concatenation of self.
\n\n", arg:["num"], lines:[78, 78], file:"lib/string.fy"}, "lowercase":{doc:"

Example:

\n\n
 \"HELLO WORLD\" lowercase # => \"hello world\"\n
\n\n
Lowercased version of self.
\n\n", lines:[580, 580], file:"kernel/common/string.rb"}, "uppercase":{doc:"

Example:

\n\n
 \"hello world\" uppercase # => \"HELLO WORLD\"\n
\n\n
Uppercased version of self.
\n\n", lines:[1549, 1549], file:"kernel/common/string.rb"}, ":downcase":{doc:"

Example:

\n\n
 \"HELLO WORLD\" lowercase # => \"hello world\"\n
\n\n
Lowercased version of self.
\n\n", lines:[580, 580], file:"kernel/common/string.rb"}, ":bytes":{doc:"\n\n
Fancy Enumerator of all bytes (Fixnum values) in self.
\n\n", arg:[], lines:[184, 184], file:"lib/string.fy"}, "upcase":{doc:"

Example:

\n\n
 \"hello world\" uppercase # => \"HELLO WORLD\"\n
\n\n
Uppercased version of self.
\n\n", lines:[1549, 1549], file:"kernel/common/string.rb"}, ":[]":{doc:"

Given an Array of 2 Numbers, it returns the substring between the given indices.\nIf given a Number, returns the character at that index.

\n\n
\n\n", arg:["index"], lines:[24, 24], file:"lib/rbx/string.fy"}, "substitute:with:":{doc:"\n\n
String to replace substring with.
String or Regexp to be substituted.
A new String where substring is substituted by substitution.
\n\n", arg:["substring", "substitution"], lines:[164, 164], file:"lib/rbx/string.fy"}, ":<<":{doc:"

Appends object's String representation to self.

\n\n

Example:

\n\n
 str = \"hello\"\n str << \" \"\n str << 42\n str # => \"hello 42\"\n
\n\n
An Object who's String representation will be appended to self.
self, but modified.
\n\n", arg:["object"], lines:[140, 140], file:"lib/string.fy"}, "relative_path:":{doc:"

Example:

\n\n
 __FILE__ relative: \"../foo/bar\"\n
\n\n
Relative path to self.
Absolute File path relative to self.
\n\n", arg:["path"], lines:[199, 199], file:"lib/string.fy"}, ":upcase":{doc:"

Example:

\n\n
 \"hello world\" uppercase # => \"HELLO WORLD\"\n
\n\n
Uppercased version of self.
\n\n", lines:[1549, 1549], file:"kernel/common/string.rb"}, ":whitespace?":{doc:"

Indicates, if a String is empty or a single whitespace character.

\n\n
true, if self consists only of a single whitespace character or is empty, false otherwise.
\n\n", arg:[], lines:[50, 50], file:"lib/string.fy"}, ":skip_leading_indentation":{doc:"

Remove leading white space for multi-line strings.\nThis method expects the first character to be an line return.

\n\n
\n\n", arg:[], lines:[148, 148], file:"lib/string.fy"}, ":++":{doc:"

Concatenate self with another Object's String representation.

\n\n
 \"foo\\\342\200\235 ++ 42 # => \\\342\200\235foo42\\\342\200\235\n
\n\n
Object to concatenate self with as a String.
Concatenation of self with other.
\n\n", arg:["other"], lines:[40, 40], file:"lib/string.fy"}, "includes?:":{doc:"

Indicates if a given substring is in self.

\n\n
String to be checked if it's in self.
true if substring is in self, false otherwise.
\n\n", arg:["substring"], lines:[154, 154], file:"lib/rbx/string.fy"}, ":eval_global":{doc:"

Same as String#eval but evaluates self in the global binding.

\n\n
\n\n", arg:[], lines:[93, 93], file:"lib/rbx/string.fy"}}}, "KVO":{methods:{}, ancestors:["KVO", "Object", "Kernel"], doc:"

Key-Value Observing Mixin class.\nInclude this Class into any class to add support for Key-Value Observing.\nInspired by Objective-C's KVO, but using Blocks, as it fits nicer\nwith Fancy's semantics.

\n\n

Example:

\n\n
 class Person {\n   include: KVO\n   read_write_slots: ('name, 'age, 'city)\n }\n\n tom = Person new tap: @{\n   name: \"Tom Cruise\"\n   age: 55\n   city: \"Hollywood\"\n }\n\n tom observe: 'name with: |new old| {\n   new println\n }\n tom name: \"Tommy Cruise\"              # will cause \"Tommy Cruise\" to be printed\n tom age: 56                           # No observer Blocks defined, so nothing will happen\n
\n\n
\n\n", instance_methods:{"observe:with:":{doc:"

Registers a new observer Block for slotname in self.

\n\n
Block to be called with old and new value of slotname in self.
Name of slot to be observed with block.
\n\n", arg:["slotname", "block"], lines:[68, 68], file:"lib/kvo.fy"}, "observe_removal:with:":{doc:"

Registers a new removal observer Block for collection named slotname in self.

\n\n
Block to be called with value removed from collection named slotname in self.
Name of collection slot to be observed with block.
\n\n", arg:["slotname", "block"], lines:[90, 90], file:"lib/kvo.fy"}, "observe_insertion:with:":{doc:"

Registers a new insertion observer Block for collection named slotname in self.

\n\n
Block to be called with value inserted in collection named slotname in self.
Name of collection slot to be observed with block.
\n\n", arg:["slotname", "block"], lines:[79, 79], file:"lib/kvo.fy"}}}, "Fancy Package RubyDependency":{methods:{}, ancestors:["Fancy Package RubyDependency", "Object", "Kernel"], doc:"

Same as Fancy Package Dependency, just for rubygem packages.

\n\n
\n\n", instance_methods:{"initialize:":{doc:"

Forward to message initialize:version:

\n\n
\n\n", arg:["@gem_name"], lines:[22, 22], file:"lib/package/dependency.fy"}, ":install":{doc:"

Installs the RubyDependency (a RubyGem) via rbx -S gem on the system.

\n\n
\n\n", arg:[], lines:[29, 29], file:"lib/package/dependency.fy"}}}, "Number":{methods:{}, ancestors:["Number", "Object", "Kernel"], doc:"

Number is a mixin-class for all number values (integer & floats for\nnow).

\n\n
\n\n", instance_methods:{":even?":{doc:"

Indicates, if a Number is even.

\n\n
true, if self is even, false otherwise.
\n\n", arg:[], lines:[177, 177], file:"lib/number.fy"}, "upto:in_steps_of:do:":{doc:"

Calls block every steps steps between self and num with the current Number.\nExpects num to be greater or equal to self.

\n\n
A Block that should be called every steps steps between self and num.
Maximum Number to call block with.
Number of numbers to skip each step.
self
\n\n\n

\n", arg:["num", "steps", "block"], lines:[53, 53], file:"lib/number.fy"}, ":cubed":{doc:"

Returns the cubed value of a Number.

\n\n
Cubed value of self.
\n\n", arg:[], lines:[143, 143], file:"lib/number.fy"}, "downto:":{doc:"

Returns an Array with Numbers starting at self and going down to num.\nExpects num to be smaller or equal to self.

\n\n
Number to create an Array down to.
Array containing numbers from self down to num.
\n\n", arg:["num"], lines:[70, 70], file:"lib/number.fy"}, "downto:in_steps_of:do:":{doc:"

Calls block every steps steps between self and num with the current Number.\nExpects num to be smaller or equal to self.

\n\n
A Block that should be called every steps steps between self and num.
Minimum Number to call block with.
Number of numbers to skip each step.
self
\n\n\n

\n", arg:["num", "steps", "block"], lines:[108, 108], file:"lib/number.fy"}, "upto:":{doc:"

Returns an Array with Numbers starting at self and going up to num.\nExpects num to be greater or equal to self.

\n\n
Number to create an Array up to.
Array containing numbers from self to num.
\n\n", arg:["num"], lines:[16, 16], file:"lib/number.fy"}, ":negate":{doc:"

Negates a Number (-1 becomes 1 and vice versa).

\n\n
Negated value of self.
\n\n", arg:[], lines:[167, 167], file:"lib/number.fy"}, ":abs":{doc:"

Returns the absolute (positive) value of a Number.

\n\n
Absolute (positive) value of self.
\n\n", arg:[], lines:[158, 158], file:"lib/number.fy"}, "min:":{doc:"\n\n
Minimum value of self and other.
\n\n", arg:["other"], lines:[212, 212], file:"lib/number.fy"}, "upto:do:":{doc:"

Calls block with each Number between self and num.\nExpects num to be greater or equal to self.

\n\n
A Block that should be called with each Number between self and num.
Maximum Number to call block with.
self
\n\n\n

\n", arg:["num", "block"], lines:[34, 34], file:"lib/number.fy"}, "max:":{doc:"\n\n
Maximum value of self and other.
\n\n", arg:["other"], lines:[200, 200], file:"lib/number.fy"}, ":odd?":{doc:"

Indicates, if a Number is odd.

\n\n
true, if self is odd, false otherwise.
\n\n", arg:[], lines:[187, 187], file:"lib/number.fy"}, ":squared":{doc:"

Returns the square of a Number.

\n\n
Squared value of self.
\n\n", arg:[], lines:[123, 123], file:"lib/number.fy"}, ":doubled":{doc:"

Returns the double value of a Number.

\n\n
Doubled value of self.
\n\n", arg:[], lines:[133, 133], file:"lib/number.fy"}, "downto:do:":{doc:"

Calls block with each Number between self and num.\nExpects num to be smaller or equal to self.

\n\n
A Block that should be called with each Number between self and num.
Minimum Number to call block with.
self
\n\n\n

\n", arg:["num", "block"], lines:[89, 89], file:"lib/number.fy"}}}, "Block":{methods:{}, ancestors:["Rubinius BlockEnvironment", "Object", "Kernel"], doc:"

The Block class (also BlockEnvironment) is the class of all\nBlock-literal values.\nA Block is a piece of unevaluated code, that can be passed around as\nany other value and evaluated by calling the +call+ or +call:+ methods.

\n\n

Blocks also work properly with their enclosing environment in that\nthey preserve any local variables that get used within the Block,\neven if the context in which they got defined has been destroyed.\n=> Blocks are proper closures.

\n\n

See: http://en.wikipedia.org/wiki/Closure_(computer_science) for\nmore information.

\n\n
\n\n", instance_methods:{":to_hash":{doc:"

Creates and returns a new Hash with keys and values defined dynamically in self.\nSimilar to Block object but returning a Hash instead of an Object

\n\n

Example:

\n\n
 o = {\n   something: \"foo bar baz\"\n   with: 42\n } to_hash   # => <['something => \"foo bar baz\", 'with => 42]>\n
\n\n
\n\n", arg:[], lines:[171, 171], file:"lib/block.fy"}, "while_nil:":{doc:"

Executes a given Block while self evals to nil or false.

\n\n

Example:

\n\n
 i = 0\n { i >= 10 } while_false: {\n   i println\n   i = i + 1\n }\n
\n\n
\n\n", arg:["block"], lines:[29, 29], file:"lib/block.fy"}, "call:with_receiver:":{doc:"

Same as call_with_receiver: but passing along arguments to the Block.

\n\n

Example:

\n\n
 r1 = [1,2,3]\n r2 = \"hello world\"\n b = |arg| { self to_s + arg }\n b call: [\"foo\"] with_receiver: r1 # => \"123foo\"\n b call: [\"foo\"] with_receiver: r2 # => \"hello worldfoo\"\n
\n\n
Receiver (value of self) when calling the Block.
Array of arguments passed to self for invocation.
\n\n", arg:["args", "receiver"], lines:[93, 93], file:"lib/rbx/block.fy"}, ":receiver":{doc:"

Returns the receiver of the Block (value for self)

\n\n
Receiver object of a Block.
\n\n", arg:[], lines:[38, 38], file:"lib/rbx/block.fy"}, ":to_a":{doc:"

Creates and returns a new Array with values defined dynamically in self.\nSimilar to Block to_hash but returning an Array instead of a Hash

\n\n

Example:

\n\n
 a = {\n   something: \"foo bar baz\"\n   with: 42\n   something; else\n } to_a   # => [['something, \"foo bar baz\"], ['with, 42], 'something, 'else]\n
\n\n
\n\n", arg:[], lines:[205, 205], file:"lib/block.fy"}, "until_do:":{doc:"

Calls a given Block as long as self yields nil or false.

\n\n
Block to be called while self yields nil or false.
\n\n", arg:["block"], lines:[59, 59], file:"lib/block.fy"}, "while_do:":{doc:"

Calls block while calling self yields a true-ish value.

\n\n
Block to call while self yields true.
\n\n", arg:["block"], lines:[48, 48], file:"lib/block.fy"}, ":to_proc":{doc:"

Turns a Block into a Ruby Proc object.

\n\n
Ruby Proc representing self.
\n\n", arg:[], lines:[102, 102], file:"lib/rbx/block.fy"}, ":||":{doc:"

Short-circuiting || (boolean OR).

\n\n
\n\n", arg:["other_block"], lines:[87, 87], file:"lib/block.fy"}, "until:":{doc:"

Calls self while block yields nil or false.

\n\n
Condition Block to be called to determine if self should be called.
\n\n", arg:["block"], lines:[69, 69], file:"lib/block.fy"}, "while_true:":{doc:"

Calls block while calling self yields a true-ish value.

\n\n
Block to call while self yields true.
\n\n", arg:["block"], lines:[48, 48], file:"lib/block.fy"}, ":[]":{doc:"

Same as Block#call:

\n\n
\n\n", arg:["args"], lines:[137, 137], file:"lib/block.fy"}, "if:":{doc:"

Calls self if obj is true-ish.

\n\n
Condition object to determine if self should be called.
\n\n", arg:["obj"], lines:[99, 99], file:"lib/block.fy"}, ":to_hash_deep":{doc:"

Creates and returns a new Hash with keys and values defined dynamically in self.\nSimilar to Block to_hash but converting any value that's a Block to a Hash as well.

\n\n

Example:

\n\n
 o = {\n   something: \"foo bar baz\"\n   with: 42\n   and: {\n     another: 'field\n   }\n } to_hash_deep   # => <['something => \"foo bar baz\", 'with => 42, 'and => <['another => 'field]>]>\n
\n\n
\n\n", arg:[], lines:[189, 189], file:"lib/block.fy"}, ":to_object":{doc:"

Creates and returns a new Object with slots defined dynamically in self.\nLooks and feels similar to Javascript object literals.

\n\n

Example:

\n\n
 o = {\n   something: \"foo bar baz\"\n   with: 42\n } to_object\n\n o something # => \"foo bar baz\"\n o with      # => 42\n
\n\n
\n\n", arg:[], lines:[154, 154], file:"lib/block.fy"}, "call_with_receiver:":{doc:"

Calls a Block with receiver as the receiver (referenced by self within the Block).

\n\n

Example:

\n\n
 r1 = [1,2,3]\n r2 = \"hello world\"\n b = { self class }\n b call_with_receiver: r1 # => Array\n b call_with_receiver: r2 # => String\n
\n\n
Receiver (value of self) when calling the Block.
\n\n", arg:["receiver"], lines:[71, 71], file:"lib/rbx/block.fy"}, ":&&":{doc:"

Short-circuiting && (boolean AND).

\n\n
\n\n", arg:["other_block"], lines:[80, 80], file:"lib/block.fy"}, "unless:":{doc:"

Opposite of Block#if:. Calls self if obj is false-ish.

\n\n
Condition object to determine if self should not be called.
\n\n", arg:["obj"], lines:[109, 109], file:"lib/block.fy"}, "while_false:":{doc:"

Executes a given Block while self evals to nil or false.

\n\n

Example:

\n\n
 i = 0\n { i >= 10 } while_false: {\n   i println\n   i = i + 1\n }\n
\n\n
\n\n", arg:["block"], lines:[29, 29], file:"lib/block.fy"}, ":===":{doc:"

Matches a Block against another object by calling self with val.

\n\n
Value of calling self with val.
Other object to match self against.
\n\n", arg:["val"], lines:[121, 121], file:"lib/block.fy"}, "receiver:":{doc:"

Sets the receiver (value for self) of a Block.

\n\n
New receiver object for a Block.
\n\n", arg:["recv"], lines:[47, 47], file:"lib/rbx/block.fy"}}}, "Float":{methods:{}, ancestors:["Float", "Number", "Object", "Precision", "Numeric", "Comparable", "Object", "Kernel"], doc:"

Standard class for floating point number values in Fancy.

\n\n
\n\n", instance_methods:{}}, "Fancy MessageSink":{methods:{}, ancestors:["Fancy MessageSink", "BasicObject", "Object", "Kernel"], doc:"

A MessageSink just swallows all messages that are sent to it.

\n\n
\n\n", instance_methods:{"unknown_message:with_params:":{doc:"

m Message sent to self.\np Array of parameters sent along with m.

\n\n

Catches all messages and arguments and simply always returns self.

\n\n
self.
\n\n", arg:["m", "p"], lines:[16, 16], file:"lib/message_sink.fy"}}}, "FalseClass":{methods:{}, ancestors:["FalseClass", "ImmediateValue", "Object", "Kernel"], doc:"

FalseClass. The class of the singleton false value.

\n\n
\n\n", instance_methods:{":not":{doc:"

Boolean negation of false => true.

\n\n
true
\n\n\n

\n", arg:[], lines:[62, 62], file:"lib/false_class.fy"}, "if_true:":{doc:"

Returns nil.

\n\n
\n\n", arg:["block"], lines:[14, 14], file:"lib/false_class.fy"}, "if_true:else:":{doc:"

Calls else_block.

\n\n
\n\n", arg:["then_block", "else_block"], lines:[19, 19], file:"lib/false_class.fy"}, ":to_a":{doc:"

Returns an empty Array.

\n\n
\n\n", arg:[], lines:[52, 52], file:"lib/false_class.fy"}, ":to_s":{doc:"

Returns false as a String.

\n\n
\n\n", arg:[], lines:[45, 45], file:"lib/false_class.fy"}, ":false?":{doc:"

Returns true.

\n\n
\n\n", arg:[], lines:[40, 40], file:"lib/false_class.fy"}, ":inspect":{doc:"

Returns false as a String.

\n\n
\n\n", arg:[], lines:[45, 45], file:"lib/false_class.fy"}}}, "Fancy Documentation RDiscount":{methods:{"rdiscount:":{doc:"

Format string as HTML using RDiscount ruby gem.

\n\n
\n\n", arg:["doc"], lines:[123, 123], file:"lib/documentation.fy"}}, ancestors:["Fancy Documentation RDiscount", "Object", "Kernel"], doc:"

A documentation formatter using ruby's RDiscount markdown

\n\n
\n\n", instance_methods:{}}, "TCPServer":{methods:{}, ancestors:["TCPServer", "Socket ListenAndAccept", "IO Socketable", "TCPSocket", "IPSocket", "BasicSocket", "IO", "IOMixin", "Object", "Unmarshalable", "File Constants", "Enumerable", "Object", "Kernel"], doc:"

TCP Server

\n\n
\n\n", instance_methods:{}}, "Object":{methods:{}, ancestors:["Object", "Kernel"], doc:"

Root class of Fancy's class hierarchy.\nAll classes inherit from Object.

\n\n
\n\n", instance_methods:{"send_async:with_params:":{doc:"

Sends message with params to self asynchronously and immediately returns nil.

\n\n
Array of parameters as part of sending message asynchronously to self.
Message to be sent asynchronously to self.
nil
\n\n\n

\n", arg:["message", "params"], lines:[525, 525], file:"lib/object.fy"}, "if_false:else:":{doc:"

Calls else_block (default behaviour).

\n\n
Does not get called (default behaviour).
Block to be called.
Value of calling else_block.
\n\n", arg:["then_block", "else_block"], lines:[104, 104], file:"lib/object.fy"}, ":break":{doc:"

Breaks / Stops current iteration.

\n\n
\n\n", arg:[], lines:[433, 433], file:"lib/object.fy"}, ":to_enum":{doc:"\n\n
Fancy Enumerator for self using 'each: for iteration.
\n\n", arg:[], lines:[155, 155], file:"lib/object.fy"}, "returning:do:":{doc:"

Returns value after calling block with it.\nUseful for returning some object after using it, e.g.:

\n\n
 # this will return [1,2]\n returning: [] do: |arr| {\n   arr << 1\n   arr << 2\n }\n
\n\n
A Block that gets called with value before returning value.
Value that gets returned at the end.
value
\n\n\n

\n", arg:["value", "block"], lines:[348, 348], file:"lib/object.fy"}, ":to_a":{doc:"\n\n
Array representation of self.
\n\n", arg:[], lines:[139, 139], file:"lib/object.fy"}, "do:while:":{doc:"\n\n
Condition Block used to determine if body_block@ should be called again.
Block to be called at least once and as long as cond_block yields a true-ish value.
\n\n", arg:["body_block", "cond_block"], lines:[261, 261], file:"lib/object.fy"}, "while:do:":{doc:"

Same as:\ncond_block while_do: body_block

\n\n
\n\n", arg:["cond_block", "body_block"], lines:[243, 243], file:"lib/object.fy"}, "next:":{doc:"

Returns value for current iteration and skip to the next one.

\n\n
Value for next iteration.
\n\n", arg:["value"], lines:[425, 425], file:"lib/object.fy"}, ":?":{doc:"

Calls #value on future. Shortcut method.

\n\n
Future object to get the value from.
Result of calling #value on future.
\n\n", arg:["future"], lines:[391, 391], file:"lib/object.fy"}, ":&&":{doc:"

Boolean conjunction.\nIf self and other are both true-ish (non-nil, non-false), returns other.\nIf other is a Block, calls it and returns its return value.

\n\n
Object or Block (for short-circuit evaluation) to compare self to.
other if both self and other are true-ish, self otherwise.
\n\n", arg:["other"], lines:[183, 183], file:"lib/object.fy"}, "get_slots:":{doc:"\n\n
Array of slot names to retrieve from self.
Array of slot values of slot names passed in via slots.
\n\n", arg:["slots"], lines:[570, 570], file:"lib/object.fy"}, ":actor":{doc:"

Returns the Object's actor.\nIf none exists at this moment, a new one will be created\nand starts running in the background.

\n\n
\n\n", arg:[], lines:[501, 501], file:"lib/object.fy"}, "loop:":{doc:"

Infinitely calls the block (loops).

\n\n
Block to be called endlessly (loop).
\n\n", arg:["block"], lines:[26, 26], file:"lib/object.fy"}, ":dclone":{doc:"

Returns a deep clone of self using Ruby's Marshal class.

\n\n
\n\n", arg:[], lines:[19, 19], file:"lib/rbx/object.fy"}, "if_true:":{doc:"

Calls the block (default behaviour).

\n\n
Block to be called.
Value of calling block with self.
\n\n", arg:["block"], lines:[70, 70], file:"lib/object.fy"}, "if_true:else:":{doc:"

Calls the then_block (default behaviour).

\n\n
Block to be called.
Does not get called (default behaviour).
Value of calling then_block with self.
\n\n", arg:["then_block", "else_block"], lines:[83, 83], file:"lib/object.fy"}, "copy_slots:from:":{doc:"

Copies slots from object to self.

\n\n
Fancy Enumerable of slot names to copy from object.
Target Object to copy slots from.
\n\n", arg:["slots", "object"], lines:[549, 549], file:"lib/object.fy"}, "do:":{doc:"

Helper method that calls block with self as the receiver.\nThis allows message cascading like code, e.g.:

\n\n
 some_complex_object do: {\n   method_1: arg1\n   method_2: arg2\n   method_3: arg3\n }\n\n # this is the same as:\n some_complex_object method_1: arg1\n some_complex_object method_2: arg2\n some_complex_object method_3: arg3\n
\n\n
Block to be called in the context of self.
self.
\n\n", arg:["block"], lines:[606, 606], file:"lib/object.fy"}, "send_async:":{doc:"

Forward to message send_async:with_params:

\n\n
\n\n", arg:["message"], lines:[516, 516], file:"lib/object.fy"}, "receive_message:with_params:":{doc:"

Dynamically sends a given message with parameters to self.

\n\n
Array of parameters used with message.
Name of message to be sent to self dynamically.
\n\n", arg:["message", "params"], lines:[112, 112], file:"lib/rbx/object.fy"}, ":next":{doc:"

Skip to the next iteration.

\n\n
\n\n", arg:[], lines:[415, 415], file:"lib/object.fy"}, ":nil?":{doc:"\n\n
false.
\n\n", arg:[], lines:[115, 115], file:"lib/object.fy"}, "receive_message:":{doc:"

Dynamically sends a given message (without parameters) to self.

\n\n
Name of message to be sent to self dynamically.
\n\n", arg:["message"], lines:[101, 101], file:"lib/rbx/object.fy"}, ":yield":{doc:"

Same as Fiber##yield.

\n\n
\n\n", arg:[], lines:[399, 399], file:"lib/object.fy"}, "set_slot:value:":{doc:"

Sets an object's slot with a given value.

\n\n
Name of slot to be set.
Value for slot to be set.
\n\n", arg:["slotname", "val"], lines:[39, 39], file:"lib/rbx/object.fy"}, ":true?":{doc:"\n\n
false.
\n\n", arg:[], lines:[131, 131], file:"lib/object.fy"}, "sleep:":{doc:"

Sets the current Thread (in which self is running) for a given amount to sleep.

\n\n
Amount of seconds to sleep.
\n\n", arg:["seconds"], lines:[637, 637], file:"lib/object.fy"}, ":!=":{doc:"

Indicates, if two objects are not equal.

\n\n
Other object to compare against.
true if self is not equal to other, false otherwise.
\n\n", arg:["other"], lines:[59, 59], file:"lib/object.fy"}, "require:":{doc:"

Loads and evaluates a given Fancy source file by trying to find the specified\nRelative paths are allowed (and by default expected).

\n\n
in Fancy's loadpath (see Fancy CodeLoader).
\n\n", arg:["file_path"], lines:[14, 14], file:"lib/rbx/object.fy"}, "responds_to?:":{doc:"

Indicates if an object responds to a given message.

\n\n
The message to check for (preferably a Symbol).
true if self responds to message, false otherwise.
\n\n", arg:["message"], lines:[132, 132], file:"lib/rbx/object.fy"}, "yield:":{doc:"

Same as Fiber##yield:

\n\n
\n\n", arg:["values"], lines:[407, 407], file:"lib/object.fy"}, ":to_s":{doc:"\n\n
String represenation of self.
\n\n", arg:[], lines:[28, 28], file:"lib/rbx/object.fy"}, "define_singleton_method:with:":{doc:"

Dynamically defines a method on self's metaclass (a singleton method) using a given Block.

\n\n
Block to be used as the method's body.
Name of the method to be defined on self.
\n\n", arg:["name", "block"], lines:[60, 60], file:"lib/rbx/object.fy"}, "if:then:":{doc:"

Same as:\ncond if_true: block

\n\n
\n\n", arg:["cond", "block"], lines:[225, 225], file:"lib/object.fy"}, ":print":{doc:"

Same as:\nstdout print: self

\n\n

Prints self on stdout.

\n\n
\n\n", arg:[], lines:[48, 48], file:"lib/object.fy"}, "until:do:":{doc:"

Same as:\ncond_block until_do: body_block

\n\n
\n\n", arg:["cond_block", "body_block"], lines:[252, 252], file:"lib/object.fy"}, "documentation:":{doc:"

Sets the documentation string for an Object.

\n\n
New docstring for self.
\n\n", arg:["docstring"], lines:[319, 319], file:"lib/object.fy"}, "is_a?:":{doc:"

Indicates, if an object is an instance of a given Class.

\n\n
Class to check for if self is an instance of.
true if self is an instance of class, false otherwise.
\n\n", arg:["class"], lines:[82, 82], file:"lib/rbx/object.fy"}, ":die!":{doc:"

Tells an object to let its actor to die (quit running).

\n\n
\n\n", arg:[], lines:[491, 491], file:"lib/object.fy"}, "do:until:":{doc:"\n\n
Condition Block used to determine if body_block@ should be called again.
Block to be called at least once and as long as cond_block yields a false-ish value.
\n\n", arg:["body_block", "cond_block"], lines:[271, 271], file:"lib/object.fy"}, "tap:":{doc:"

Calls a given Block with self before returning self.

\n\n
Block to be called with self.
self.
\n\n", arg:["block"], lines:[618, 618], file:"lib/object.fy"}, "xor:":{doc:"\n\n
Object to compare self against.
true if only one of self and other is true, false otherwise.
\n\n", arg:["other"], lines:[214, 214], file:"lib/object.fy"}, ":<=>":{doc:"\n\n
Other object to compare against.
-1 if self is smaller, 0 if self is equal or 1 if self is greater or equal compared to other.
\n\n", arg:["other"], lines:[581, 581], file:"lib/object.fy"}, "copy_slots_from:":{doc:"

Copies all slots from object to self.

\n\n
Object to copy slots from.
\n\n", arg:["object"], lines:[562, 562], file:"lib/object.fy"}, "if:then:else:":{doc:"

Same as:\ncond if_true: then_block else: else_block

\n\n
\n\n", arg:["cond", "then_block", "else_block"], lines:[234, 234], file:"lib/object.fy"}, "if_nil:else:":{doc:"

Calls else_block (default behaviour).

\n\n
Does not get called (default behaviour).
Block to be called.
Value of calling else_block.
\n\n", arg:["then_block", "else_block"], lines:[104, 104], file:"lib/object.fy"}, ":if_responds?":{doc:"

Returns a RespondsToProxy for self that forwards any messages\nonly if self responds to them.

\n\n

Example:

\n\n
 # only send 'some_message: if object responds to it:\n object if_responds? some_message: some_parameter\n
\n\n
RespondsToProxy for self
\n\n\n

\n", arg:[], lines:[365, 365], file:"lib/object.fy"}, "unless:do:":{doc:"

Same as:\ncond if_true: { nil } else: block

\n\n
\n\n", arg:["cond", "block"], lines:[281, 281], file:"lib/object.fy"}, "let:be:":{doc:"

Forward to message let:be:in:

\n\n
\n\n", arg:["var_name", "value"], lines:[640, 640], file:"lib/object.fy"}, ":documentation":{doc:"

Returns the Fancy Documentation object for an Object.

\n\n
Fancy Documentation object for self.
\n\n", arg:[], lines:[309, 309], file:"lib/object.fy"}, "kind_of?:":{doc:"

Same as Object#is_a?:\nIndicates, if an object is an instance of a given Class.

\n\n
\n\n", arg:["class"], lines:[91, 91], file:"lib/rbx/object.fy"}, "send_future:":{doc:"

Forward to message send_future:with_params:

\n\n
\n\n", arg:["message"], lines:[504, 504], file:"lib/object.fy"}, ":println":{doc:"

Same as:\nstdout println: self

\n\n

Prints self on stdout, followed by a newline.

\n\n
\n\n", arg:[], lines:[37, 37], file:"lib/object.fy"}, "let:be:in:":{doc:"

Dynamically rebinds var_name as dynamic variable with value as the value within block.

\n\n

Example:

\n\n
 File write: \"/tmp/output.txt\" with: |f| {\n   let: '*stdout* be: f in: {\n     \"hello, world!\" println # writes it to file not STDOUT\n   }\n }\n
\n\n
Block in which var_name will be dynamically bound to value.
Symbol that represents the name of the dynamic variable to be set.
Value for the variable.
Returns value
\n\n\n

\n", arg:["var_name", "value", "block"], lines:[657, 657], file:"lib/object.fy"}, "if_nil:":{doc:"

Does nothing (default behaviour).

\n\n
nil
\n\n\n

\n", arg:["block"], lines:[92, 92], file:"lib/object.fy"}, "undefine_singleton_method:":{doc:"

Undefines a singleton method of self.

\n\n
Name of the method to be undefined no self's metaclass.
\n\n", arg:["name"], lines:[70, 70], file:"lib/rbx/object.fy"}, "to_enum:":{doc:"\n\n
Fancy Enumerator for self using iterator for iteration.
Message to use for iteration on self.
\n\n", arg:["iterator"], lines:[164, 164], file:"lib/object.fy"}, ":identity":{doc:"

The identity method simply returns self.

\n\n
self.
\n\n", arg:[], lines:[329, 329], file:"lib/object.fy"}, "backtick:":{doc:"

This is the default implementation for backtick: which gets called when using the backtick syntax.\nFor example:\ncat README\nGets translated to the following message send:\nself backtick: \"cat README\"\nWhich allows for custom implementations of the backtick: method, if needed.\nThis default implementation works the same way as in Ruby, Perl or Bash.\nIt returns the output of running the given string on the command line as a String.

\n\n
\n\n", arg:["str"], lines:[380, 380], file:"lib/object.fy"}, "break:":{doc:"

Returns value from iteratioen.

\n\n
Value to return from iteration.
\n\n", arg:["value"], lines:[443, 443], file:"lib/object.fy"}, "unless:do:else:":{doc:"

Same as:\ncond if_true: else_block else: block

\n\n
\n\n", arg:["cond", "block", "else_block"], lines:[290, 290], file:"lib/object.fy"}, "extend:":{doc:"

Extends self with the methods in class (by including its methods in self's metaclass).

\n\n
Class to extend self with.
\n\n", arg:["class"], lines:[141, 141], file:"lib/rbx/object.fy"}, "with_output_to:do:":{doc:"

Opens filename and rebinds *stdout* to it within block.

\n\n

Example:

\n\n
 with_output_to: \"/tmp/hello_world.txt\" do: {\n   \"hello\" println\n   \"world\" println\n }\n
\n\n

This writes

\n\n
 hello\n world\n
\n\n

to /tmp/hello_world.txt

\n\n
Block to be executed with *stdout* being bound to the output file.
Filename of file to write to.
\n\n", arg:["filename", "block"], lines:[694, 694], file:"lib/object.fy"}, "send_future:with_params:":{doc:"

Creates a FutureSend object (a Future / Promise) that will hold the value of sending message to self.

\n\n
Array of parameters of the FutureSend.
Message to be sent as a FutureSend.
FutureSend object that will hold the return value of message with params on self.
\n\n", arg:["message", "params"], lines:[513, 513], file:"lib/object.fy"}, ":false?":{doc:"\n\n
false.
\n\n", arg:[], lines:[123, 123], file:"lib/object.fy"}, ":||":{doc:"

Boolean disjunction.\nIf self is true-ish (non-nil, non-false) returns self.\nOtherwise returns other (if other is a Block, calls it first and returns its return value)

\n\n
Object or Block (for short-circuit evaluation) to compare self to.
self if self is true-ish, other otherwise.
\n\n", arg:["other"], lines:[201, 201], file:"lib/object.fy"}, "synchronized:":{doc:"

Runs a given Block in a synchronized fashion if called by multiple Threads.\nUses a Mutex in the background for synchronization (created on demand for each Object).

\n\n
Block to be run only by one Thread at a time.
\n\n", arg:["block"], lines:[537, 537], file:"lib/object.fy"}, "if_false:":{doc:"

Does nothing (default behaviour).

\n\n
nil
\n\n\n

\n", arg:["block"], lines:[92, 92], file:"lib/object.fy"}, ":to_i":{doc:"\n\n
Fixnum representation of self.
\n\n", arg:[], lines:[147, 147], file:"lib/object.fy"}, "and:":{doc:"

Boolean conjunction.\nIf self and other are both true-ish (non-nil, non-false), returns other.\nIf other is a Block, calls it and returns its return value.

\n\n
Object or Block (for short-circuit evaluation) to compare self to.
other if both self and other are true-ish, self otherwise.
\n\n", arg:["other"], lines:[183, 183], file:"lib/object.fy"}, ":++":{doc:"

Returns the String concatenation of self and other.\nCalls to_s on self and other and concatenates the results to a new String.

\n\n
Other object to concatenate its String value with.
String concatenation of String values of self and other.
\n\n", arg:["other"], lines:[16, 16], file:"lib/object.fy"}, "or:":{doc:"

Boolean disjunction.\nIf self is true-ish (non-nil, non-false) returns self.\nOtherwise returns other (if other is a Block, calls it first and returns its return value)

\n\n
Object or Block (for short-circuit evaluation) to compare self to.
self if self is true-ish, other otherwise.
\n\n", arg:["other"], lines:[201, 201], file:"lib/object.fy"}, "get_slot:":{doc:"

Returns the value of a slot of self.

\n\n
Name of slot to get the value of.
Value of slot with name slotname.
\n\n", arg:["slotname"], lines:[50, 50], file:"lib/rbx/object.fy"}, "method:":{doc:"

Returns the method with a given name for self, if defined.

\n\n
Method with method_name defined for self, or nil.
\n\n", arg:["method_name"], lines:[300, 300], file:"lib/object.fy"}, ":slots":{doc:"\n\n
Array of slot names that self has.
\n\n", arg:[], lines:[627, 627], file:"lib/object.fy"}}}, "Fancy FDoc":{methods:{":main":{doc:"

FDoc will load all .fy files you give to it, and optionally run\nany specified FancySpec, and later produce documentation output.

\n\n
\n\n", arg:[], lines:[32, 32], file:"lib/fdoc.fy"}}, ancestors:["Fancy FDoc", "Object", "Kernel"], doc:"

FDoc is a tool to generate API documentation from Fancy source.

\n\n

Works as follows:

\n\n
    \n
  1. We setup a handler to be invoked every time an object is set documentation\nSee fdoc_hook.fy, its loaded even before all of lib/rbx/*.fy so we can\nAlso have documentation for all fancy rubinius.
    2. \n
  2. We load boot.fy, so we get documentation for all fancy's lib.
    3. \n
  3. We run FDoc main\nwhich can possibly load any file/directory you specify and optionally\nrun specs, effectively associating them with documented objects.
    4. \n
  4. Generate output file.\nCurrently the plan is to output a json formatted object.\nTo be loaded by an html file and use jquery to build a GUI from it.
    5. \n
\n\n\n
\n\n", instance_methods:{}}, "System":{methods:{":abort":{doc:"

Exits the current running Fancy process (application) with an exit\ncode of 1 (indicating failure).

\n\n
\n\n", arg:[], lines:[9, 9], file:"lib/system.fy"}, "pipe:do:":{doc:"

Runs the given string as a popen3() call, passing in a given Block.\nThe Block is expected to take 3 arguments for STDIN, STDOUT and STDERR.

\n\n
Block to be called with STDIN, STDOUT and STDERR.
String to run as a command via popen3()
\n\n", arg:["command_str", "block"], lines:[65, 65], file:"lib/rbx/system.fy"}, "abort:":{doc:"

Prints a given message on stderr and then exits with an exit\ncode of 1 (indicating failure).

\n\n
Error message to be printed before aborting programm execution.
\n\n", arg:["message"], lines:[19, 19], file:"lib/system.fy"}, "do:":{doc:"

Runs the given string as a system() command.

\n\n
\n\n", arg:["command_str"], lines:[31, 31], file:"lib/rbx/system.fy"}, "piperead:":{doc:"

Runs the given string as a popen() call and returns the output\nof the call as a string.

\n\n
\n\n", arg:["command_str"], lines:[40, 40], file:"lib/rbx/system.fy"}, "pipe:":{doc:"

Runs the given string as a popen3() call and returns a IO handle\nthat can be read from

\n\n
IO object representing the command's STDOUT IO stream.
String to run as a command via popen3()
\n\n", arg:["command_str"], lines:[52, 52], file:"lib/rbx/system.fy"}, "exit:":{doc:"

Exit the running Fancy process with a given exit code.

\n\n
Exit code (Fixnum) to be returned to the parent process.
\n\n", arg:["exitcode"], lines:[23, 23], file:"lib/rbx/system.fy"}, ":exit":{doc:"

Exit the running Fancy process.

\n\n
\n\n", arg:[], lines:[13, 13], file:"lib/rbx/system.fy"}}, ancestors:["System", "Object", "Kernel"], doc:"

System class. Holds system-wide relevant methods.

\n\n
\n\n", instance_methods:{}}, "Fiber":{methods:{"new:":{doc:"

Creates a new Fiber running block.

\n\n
Block to be run in a new Fiber.
\n\n", arg:["block"], lines:[18, 18], file:"lib/rbx/fiber.fy"}, "yield:":{doc:"

Returns execution control to the parent Fiber and passes along vals.

\n\n
Array of values to pass along to parent Fiber.
\n\n", arg:["vals"], lines:[28, 28], file:"lib/rbx/fiber.fy"}}, ancestors:["Rubinius Fiber", "Object", "Kernel"], doc:"

Fiber class. Fibers are cooperatively scheduled coroutines supported\nby the Rubinius VM.\nControl flow between multiple Fibers is always explicitly handled.\nThere is no preemptive scheduler.

\n\n
\n\n", instance_methods:{"resume:":{doc:"

Resumes self (if paused) or raises an exception, if Fiber is dead.\nPasses along vals as the return value of the last call to yield in self.

\n\n
Array of values to pass along to self for resuming.
\n\n", arg:["vals"], lines:[39, 39], file:"lib/rbx/fiber.fy"}}}, "Integer":{methods:{}, ancestors:["Integer", "Precision", "Numeric", "Comparable", "Object", "Kernel"], doc:"

Base class for integer values in Fancy.

\n\n
\n\n", instance_methods:{"times:offset:":{doc:"

Similar to #times: but starts at a given offset.

\n\n
Block to be called with each number between offset and self.
Offset to be used as starting point of iteration.
self.
\n\n", arg:["block", "offset"], lines:[18, 18], file:"lib/integer.fy"}, "times:":{doc:"

Calls a given Block with each number between 0 and self.

\n\n
Block to be called with each number between 0 and self.
self
\n\n\n

\n", arg:["block"], lines:[19, 19], file:"lib/rbx/integer.fy"}}}, "UnboundMethod":{methods:{}, ancestors:["UnboundMethod", "MethodMixin", "Object", "Object", "Kernel"], doc:"

An instance UnboundMethod represents a Method object not bound to a specific Class or Object.

\n\n
\n\n", instance_methods:{}}, "Time":{methods:{}, ancestors:["Time", "Comparable", "Object", "Kernel"], doc:"

Time class. Used for even more timely stuff.

\n\n
\n\n", instance_methods:{}}, "Fancy FDoc Formatter":{methods:{"create_class_references:":{doc:"

Creates class references for Fancy class names.\nA docstring may contain class names sorounded by @\nwithout space between the @.

\n\n

Nested classes can be indicated by using :: like

\n\n
 Foo::Bar\n
\n\n

This will create references for both, Foo and Bar

\n\n

Instance methods should be written:

\n\n
 Foo::Bar#baz\n
\n\n

Class methods should be written:

\n\n
 Foo::Bar.baz\n
\n\n

Some examples:\nA simple class reference:\nFancy

\n\n

Nested class reference:\nFancy FDoc

\n\n

A fancy method without arguments:\nFancy FDoc JSON generate_map

\n\n

A ruby method reference (will link to ruby docs if available)\nString split

\n\n

A fancy method with many arguments:\nFancy Package Installer initialize:version:install_path:

\n\n

A singleton method:\nFancy FDoc Formatter format:

\n\n
\n\n", arg:["str"], lines:[243, 243], file:"lib/fdoc.fy"}}, ancestors:["Fancy FDoc Formatter", "Object", "Kernel"], doc:"

A documentation formater intended to be used by FDoc.

\n\n

This formatter makes some transformations on a docstring\nand then converts it to html using markdown.

\n\n
\n\n", instance_methods:{}}, "StandardError":{methods:{}, ancestors:["StandardError", "Exception", "Object", "Kernel"], doc:"

StandardError. Base class of most Exception classes.

\n\n
\n\n", instance_methods:{"initialize:":{doc:"

Creates a new Exception with a given message.

\n\n
Message (String) for the Exception.
\n\n", arg:["msg"], lines:[31, 31], file:"lib/rbx/exception.fy"}, ":initialize":{doc:"

Creates a new Exception with an empty message.

\n\n
\n\n", arg:[], lines:[21, 21], file:"lib/rbx/exception.fy"}, ":raise!":{doc:"

Raises (throws) an Exception to be caught somewhere up the\ncallstack.

\n\n
\n\n", arg:[], lines:[40, 40], file:"lib/rbx/exception.fy"}}}, "Fancy Package Installer":{methods:{}, ancestors:["Fancy Package Installer", "Object", "Kernel"], doc:"

Fancy Package installer.

\n\n

Downloads packages from Github (usually the latest tagged version,\nif no version is specified, or the latest HEAD revision in the\nmaster branch) and install it to the FANCY_PACKAGE_DIR.

\n\n
\n\n", instance_methods:{"download_url:":{doc:"

Returns the download url for a given version of the package\nto be installed.

\n\n
\n\n", arg:["version"], lines:[110, 110], file:"lib/package/installer.fy"}, "initialize:":{doc:"

Forward to message initialize:version:install_path:

\n\n
\n\n", arg:["@package_name"], lines:[44, 44], file:"lib/package/installer.fy"}, "rename_dir:":{doc:"

Renames a given directory to a common way within the install path.\n=> It will rename the given dirname to $user/$repo-$version.

\n\n
\n\n", arg:["dirname"], lines:[158, 158], file:"lib/package/installer.fy"}, ":latest_tag":{doc:"

Returns the latest tag (sorted alphabetically).

\n\n
\n\n", arg:[], lines:[82, 82], file:"lib/package/installer.fy"}, ":run":{doc:"

Runs the installer & installs the package into\n$FANCY_PACKAGE_DIR.

\n\n
\n\n", arg:[], lines:[52, 52], file:"lib/package/installer.fy"}, ":load_fancypack":{doc:"

Loads the @.fancypack file within the downloaded package directory.\nIf no @.fancypack file is found, raise an error.

\n\n
\n\n", arg:[], lines:[167, 167], file:"lib/package/installer.fy"}, "initialize:version:":{doc:"

Forward to message initialize:version:install_path:

\n\n
\n\n", arg:["@package_name", "@version"], lines:[44, 44], file:"lib/package/installer.fy"}, ":tags":{doc:"

Returns a list of tags the repository has on Github.

\n\n
\n\n", arg:[], lines:[91, 91], file:"lib/package/installer.fy"}, "initialize:version:install_path:":{doc:"

Creates a new Package Installer@ for a given package name, an\noptional version (default is 'latest) and an optional\ninstallation path (default is the standard installation path for\nFancy packages).

\n\n
\n\n", arg:["@package_name", "@version", "@install_path"], lines:[44, 44], file:"lib/package/installer.fy"}, "has_version?:":{doc:"

Indicates, if a given version is available on Github.

\n\n
\n\n", arg:["version"], lines:[98, 98], file:"lib/package/installer.fy"}, "download_tgz:":{doc:"

Downloads the .tar.gz file from Github with the given version\n(tag or branch name) and saves it to the specified install_path.

\n\n

The Default install_path is ~/.fancy/packages/.\nIf an environment variable FANCY_PACKAGE_DIR is defined, it\nwill get used.

\n\n
\n\n", arg:["version"], lines:[135, 135], file:"lib/package/installer.fy"}}}, "Hash":{methods:{}, ancestors:["Hash", "Fancy Enumerable", "Object", "Enumerable", "Object", "Kernel"], doc:"

Class for Hashes (HashMaps / Dictionaries).\nMaps a key to a value.

\n\n
\n\n", instance_methods:{"each_value:":{doc:"

Calls a given Block with each value.

\n\n
Block to be called with each value in self.
self
\n\n\n

\n", arg:["block"], lines:[74, 74], file:"lib/hash.fy"}, "delete:":{doc:"

Deletes a key-value pair from self.

\n\n
Key of key-value pair to be deleted in self.
\n\n", arg:["key"], lines:[34, 34], file:"lib/rbx/hash.fy"}, "each_key:":{doc:"

Calls a given Block with each key.

\n\n
Block to be called with each key in self.
self
\n\n\n

\n", arg:["block"], lines:[62, 62], file:"lib/hash.fy"}, ":to_object":{doc:"

Creates and returns a new Object with slot names and values based on keys and values in self.

\n\n

Example:

\n\n
 o = <['name => \"Christopher Bertels\", 'interest => \"programming languages\"]> to_object\n o name        # => \"Christopher Bertels\"\n o interest    # => 42\n
\n\n
New Object with slots defined by keys and values in self.
\n\n", arg:[], lines:[110, 110], file:"lib/hash.fy"}, "each:":{doc:"

Calls a given Block with each key and value.

\n\n
Block to be called with each key and value in self.
self
\n\n\n

\n", arg:["block"], lines:[51, 51], file:"lib/hash.fy"}, "at:else:":{doc:"

Returns the value for a given key.\nIf the key is not found, calls else_block and returns the value it yields.

\n\n
Block to be called if key is not found.
Key of the value to get.
Value for key or value of calling else_block, if key is not found.
\n\n", arg:["key", "else_block"], lines:[33, 33], file:"lib/hash.fy"}, "includes?:":{doc:"

Indicates if a given key is in self.

\n\n
Key to search for.
true, if Hash includes key, false otherwise.
\n\n", arg:["key"], lines:[53, 53], file:"lib/rbx/hash.fy"}, "values_at:":{doc:"

Example:

\n\n
 <['foo => 1, 'bar => 2, 'baz => 42]> values_at: ('foo, 'baz) # => [1, 42]\n
\n\n
Collection of keys to get the values for.
Array of all values for the given keys.
\n\n", arg:["keys"], lines:[140, 140], file:"lib/hash.fy"}, ":to_a":{doc:"

Returns an Array of the key-value pairs in a Hash.

\n\n
Array of all key-value pairs in self.
\n\n", arg:[], lines:[86, 86], file:"lib/hash.fy"}, "fetch:else:":{doc:"

Example:

\n\n
 <['foo => 'bar]> fetch: 'foo else: { 42 } # => 'bar\n <['foo => 'bar]> fetch: 'unknown else: { 42 } # => 42\n <['nil => nil]> fetch: 'nil else: { 'not_found } # => nil\n
\n\n
Block that gets called if key not in self.
Key of value to get.
\n\n", arg:["key", "else_block"], lines:[159, 159], file:"lib/hash.fy"}, ":to_s":{doc:"

Returns a String representation of a Hash.

\n\n
String representation of self.
\n\n", arg:[], lines:[95, 95], file:"lib/hash.fy"}, ":[]":{doc:"

Returns the value for a given key.

\n\n
Key for value to get.
Value for given key or nil, if key not set.
\n\n", arg:["key"], lines:[18, 18], file:"lib/hash.fy"}}}, "IO":{methods:{}, ancestors:["IO", "IOMixin", "Object", "Unmarshalable", "File Constants", "Enumerable", "Object", "Kernel"], doc:"

Base class for IO related classes (like File, Socket, Console etc.).

\n\n
\n\n", instance_methods:{}}, "Fancy Package Dependency":{methods:{}, ancestors:["Fancy Package Dependency", "Object", "Kernel"], doc:"

Package Dependency.\nRepresents a Dependency to another Package with a given version.

\n\n
\n\n", instance_methods:{"initialize:":{doc:"

Forward to message initialize:version:

\n\n
\n\n", arg:["@name"], lines:[11, 11], file:"lib/package/dependency.fy"}}}, "Symbol":{methods:{}, ancestors:["Symbol", "ImmediateValue", "Object", "Kernel"], doc:"

Symbols are unique identifiers and only created once.

\n\n

If there are several occurrances of the same Symbol literal within\nFancy code, they all refer to the same Symbol object.

\n\n
\n\n", instance_methods:{":call":{doc:"

Sends self as message to the sender in its context.\nExample:\n'foo call\n # => same as\n self foo

\n\n

if: x then: 'foo else: 'bar\n # same as:\n if: x then: { self foo } else: { self bar }

\n\n
\n\n", arg:[], lines:[37, 37], file:"lib/symbol.fy"}, "call:":{doc:"

This allows Symbols to be used like Blocks\n(e.g. in all methods of Enumerable).\nExample:\n[1, 2, 3] map: 'squared # => [1, 4, 9]

\n\n
\n\n", arg:["arg"], lines:[22, 22], file:"lib/symbol.fy"}, ":defined?":{doc:"

Indicates if a Symbol is defined as a constant in the senders scope.

\n\n
true, if self is defined as a constant in senders scope, false otherwise.
\n\n", arg:[], lines:[20, 20], file:"lib/rbx/symbol.fy"}}}, "HTML":{methods:{}, ancestors:["HTML", "Object", "Kernel"], doc:"

HTML generator class.

\n\n

Example:

\n\n
 require: \"html\"\n html = HTML new: @{\n   html: @{\n     head: @{ title: \"My Fancy Website\" }\n     body: @{\n       div: { id: \\\342\200\235main\\\342\200\235 } with: \"Hello, Fancy World!\"\n     }\n   }\n } . to_s\n\n # html is now:\n \"\"\"\n <html>\n   <head>\n     <title>\n       My Fancy Website\n     </title>\n   </head>\n   <body>\n     <div id=\"main\">\n       Hello, Fancy World!\n     </div>\n   </body>\n </html>\n \"\"\"\n
\n\n
\n\n", instance_methods:{"open_tag:":{doc:"

Forward to message open_tag:attrs:indent:

\n\n
\n\n", arg:["name"], lines:[44, 44], file:"lib/html.fy"}, "html_block:body:":{doc:"

Forward to message html_block:body:attrs:

\n\n
\n\n", arg:["tag", "body"], lines:[71, 71], file:"lib/html.fy"}, "open_tag:attrs:":{doc:"

Forward to message open_tag:attrs:indent:

\n\n
\n\n", arg:["name", "attrs"], lines:[44, 44], file:"lib/html.fy"}}}, "Fancy StopIteration":{methods:{}, ancestors:["Fancy StopIteration", "StandardError", "Exception", "Object", "Kernel"], doc:"

Raised to stop the iteration, in particular by Enumerator#next.\nIt is rescued by Block#loop.

\n\n

Example:

\n\n
 {\n   'Hello println\n   Fancy StopIteration new raise!\n   'World println\n } loop\n 'Done! println\n
\n\n

Produces:

\n\n
 Hello\n Done!\n
\n\n
\n\n", instance_methods:{":result":{doc:"

Returns the return value of the iterator.

\n\n

o = Object new\ndef o each: block {\n block call: [1]\n block call: [2]\n block call: [3]\n 100\n}

\n\n

e = o to_enum\ne next p #=> 1\ne next p #=> 2\ne next p #=> 3\ntry {\n e next\n} catch Fancy StopIteration => ex {\n ex result p #=> 100\n}

\n\n
\n\n", arg:[], lines:[82, 82], file:"lib/iteration.fy"}}}, "Fancy NextIteration":{methods:{}, ancestors:["Fancy NextIteration", "StandardError", "Exception", "Object", "Kernel"], doc:"

Raised to continue with next iteration (and stopping the current one).\nIt is rescued by Block#loop.

\n\n
\n\n", instance_methods:{}}, "MethodMixin":{methods:{}, ancestors:["MethodMixin", "Object", "Kernel"], doc:"

Mixin class with common methods included by Method and UnboundMethod.

\n\n
\n\n", instance_methods:{":private?":{doc:"\n\n
true, if the Method is private in its defined context.
\n\n", arg:[], lines:[48, 48], file:"lib/rbx/method.fy"}, "documentation:":{doc:"\n\n
New docstring for self.
\n\n", arg:["docstring"], lines:[19, 19], file:"lib/rbx/method.fy"}, ":public?":{doc:"\n\n
true, if the Method is public in its defined context.
\n\n", arg:[], lines:[34, 34], file:"lib/rbx/method.fy"}, ":documentation":{doc:"\n\n
Docstring for self.
\n\n", arg:[], lines:[11, 11], file:"lib/rbx/method.fy"}, ":tests":{doc:"

Returns an Array of all the FancySpec SpecTests defined for a\nMethod.

\n\n
\n\n", arg:[], lines:[57, 57], file:"lib/rbx/method.fy"}, ":visibility":{doc:"\n\n
The visibility ('private, 'protected, 'public) of a Method in its defined context, if any.
\n\n", arg:[], lines:[26, 26], file:"lib/rbx/method.fy"}, ":protected?":{doc:"\n\n
true, if the Method is protected in its defined context.
\n\n", arg:[], lines:[41, 41], file:"lib/rbx/method.fy"}}}, "Class":{methods:{"superclass:body:":{doc:"

Creates a new Class by subclassing superclass and\nusing body_block as its body.

\n\n
A Block that is used as the body of the new Class.
The superclass to inherit from.
A new Class inherited from superclass.
\n\n", arg:["superclass", "body_block"], lines:[41, 41], file:"lib/rbx/class.fy"}}, ancestors:["Class", "Module", "Object", "Kernel"], doc:"

This class is the class of Class objects - e.g. Object, Array,\nString etc.\nAny class in the language is an instance of this class, as in Ruby\nor Smalltalk.

\n\n
\n\n", instance_methods:{"initialize:":{doc:"

Initializes a Class with a superclass.

\n\n
\n\n", arg:["superclass"], lines:[55, 55], file:"lib/rbx/class.fy"}, "alias_method:for:":{doc:"

Defines an alias method for another method.

\n\n
New method name to be used as an alias for old_method_name.
Name of method to alias (must exist in the Class).
\n\n", arg:["new_method_name", "old_method_name"], lines:[138, 138], file:"lib/class.fy"}, "write_slot:":{doc:"

Defines a slot writer method for a given slotname.

\n\n
Name of slot to define a setter method for.
\n\n", arg:["slotname"], lines:[85, 85], file:"lib/class.fy"}, "define_slot_reader:":{doc:"

Defines a slot reader method with a given name.\nE.g. for a slotname count it will define the following method:

\n\n
 def count {\n   get_slot: 'count\n }\n
\n\n
Name of the slot to define a getter method for.
\n\n", arg:["slotname"], lines:[25, 25], file:"lib/class.fy"}, "subclass:":{doc:"

Creates a new Class with self as superclass and the given body.

\n\n
A Block that gets used as the body of the Class.
A new Class inherited from self.
\n\n", arg:["body_block"], lines:[109, 109], file:"lib/rbx/class.fy"}, "instance_method:":{doc:"

Returns an instance method for a Class with a given name.

\n\n
Name of the instance method to return.
The instance Method with the given name or nil.
\n\n", arg:["name"], lines:[131, 131], file:"lib/rbx/class.fy"}, "read_write_slots:":{doc:"

Defines slot reader & writer methods for all given slotnames.

\n\n
Array of slotnames to define getter & setter methods for.
\n\n", arg:["slots"], lines:[94, 94], file:"lib/class.fy"}, ":nested_classes":{doc:"

Returns all the nested classes within a Class as an Array.

\n\n
Array of all nested classes for self.
\n\n", arg:[], lines:[119, 119], file:"lib/rbx/class.fy"}, "define_class_method:with:":{doc:"

Defines a class method on a Class (a singleton method) with a\ngiven name and body.

\n\n
A Block to be used as the class methods body.
Name of the class method to be defined.
\n\n", arg:["name", "block"], lines:[89, 89], file:"lib/rbx/class.fy"}, ":new":{doc:"

Creates a new Class instance by subclassing Object.

\n\n
A new Class subclassed from Object.
\n\n", arg:[], lines:[12, 12], file:"lib/rbx/class.fy"}, "alias_method:for_ruby:":{doc:"

Creates a method alias for a Ruby method.

\n\n
\n\n", arg:["new_method_name", "ruby_method_name"], lines:[147, 147], file:"lib/rbx/class.fy"}, "subclass?:":{doc:"

Indicates, if a Class is a subclass of another Class.

\n\n
Class object to check for, if self is a subclass of class_obj.
true, if self is a subclass of class_obj, false otherwise.
\n\n", arg:["class_obj"], lines:[127, 127], file:"lib/class.fy"}, ":initialize":{doc:"

Initializes a Class with Object set as superclass (default superclass).

\n\n
\n\n", arg:[], lines:[48, 48], file:"lib/rbx/class.fy"}, "private:":{doc:"

Sets any given method names to private on this Class.

\n\n
One or more (Array) method names (as a Symbol) to be set to private in this Class.
\n\n", arg:["method_names"], lines:[168, 168], file:"lib/rbx/class.fy"}, "protected:":{doc:"

Sets any given method names to protected on this Class.

\n\n
One or more (Array) method names (as a Symbol) to be set to protected in this Class.
\n\n", arg:["method_names"], lines:[180, 180], file:"lib/rbx/class.fy"}, "undefine_method:":{doc:"

Undefines an instance method on a Class with a given name.

\n\n
Name of the method to undefine (remove) from a Class.
\n\n", arg:["name"], lines:[77, 77], file:"lib/rbx/class.fy"}, "undefine_class_method:":{doc:"

Undefines a class method on a Class with a given name.

\n\n
Name of the class method to undefine (remove).
\n\n", arg:["name"], lines:[99, 99], file:"lib/rbx/class.fy"}, "public:":{doc:"

Sets any given method names to public on this Class.

\n\n
One or more (Array) method names (as a Symbol) to be set to public in this Class.
\n\n", arg:["method_names"], lines:[156, 156], file:"lib/rbx/class.fy"}, ":forwards_unary_ruby_methods":{doc:"

Creates ruby_alias methods for any unary ruby methods of a class.

\n\n
\n\n", arg:[], lines:[190, 190], file:"lib/rbx/class.fy"}, "write_slots:":{doc:"

Defines slot writer methods for all given slotnames.

\n\n
Array of slotnames to define setter methods for.
\n\n", arg:["slots"], lines:[72, 72], file:"lib/class.fy"}, "read_slot:":{doc:"

Defines a slot reader method for a given slotname.

\n\n
Name of slot to define a getter method for.
\n\n", arg:["slotname"], lines:[63, 63], file:"lib/class.fy"}, "define_slot_writer:":{doc:"

Defines a slot writer method with a given name.\nE.g. for a slotname count it will define the following method:

\n\n
 def count: c {\n   set_slot: 'count value: c\n }\n
\n\n
Name of the slot to defnie define a setter method for.
\n\n", arg:["slotname"], lines:[41, 41], file:"lib/class.fy"}, "read_slots:":{doc:"

Defines slot reader methods for all given slotnames.

\n\n
Array of slotnames to define getter methods for.
\n\n", arg:["slots"], lines:[50, 50], file:"lib/class.fy"}, "new:":{doc:"

Creates a new Class instance by subclassing superclass.

\n\n
The superclass to inherit from.
A new Class inherited from superclass.
\n\n", arg:["superclass"], lines:[26, 26], file:"lib/rbx/class.fy"}, "read_write_slot:":{doc:"

Defines slot reader & writer methods for a given slotname.

\n\n
Name of slot to define getter & setter methods for.
\n\n", arg:["slotname"], lines:[108, 108], file:"lib/class.fy"}, "define_method:with:":{doc:"

Defines an instance method on a Class with a given name and\nbody.

\n\n
A Block that is used as the method's body.
Name of the method to be defined.
\n\n", arg:["name", "block"], lines:[67, 67], file:"lib/rbx/class.fy"}, "alias_method_rbx:for:":{doc:"

Rbx specific version of alias_method:for: due to bootstrap order\nreasons. Should not be used directly.

\n\n
\n\n", arg:["new_method_name", "old_method_name"], lines:[140, 140], file:"lib/rbx/class.fy"}}}, "Stack":{methods:{}, ancestors:["Stack", "Object", "Kernel"], doc:"

A simple Stack container class.

\n\n
\n\n", instance_methods:{"initialize:":{doc:"

Initializes a new Stack with a given size.

\n\n
Initial size of the new Stack.
\n\n", arg:["size"], lines:[21, 21], file:"lib/stack.fy"}, ":initialize":{doc:"

Initializes a new Stack.

\n\n
\n\n", arg:[], lines:[11, 11], file:"lib/stack.fy"}, ":size":{doc:"\n\n
Size of the Stack.
\n\n", arg:[], lines:[59, 59], file:"lib/stack.fy"}, ":top":{doc:"\n\n
The top-of-stack element.
\n\n", arg:[], lines:[51, 51], file:"lib/stack.fy"}, "each:":{doc:"

Calls a given Block with each element in self, starting with the top of stack element.

\n\n
Block to be called with each element in self.
self.
\n\n", arg:["block"], lines:[80, 80], file:"lib/stack.fy"}, "push:":{doc:"

Pushes a value onto the Stack.

\n\n
Object to be pushed onto self.
\n\n", arg:["obj"], lines:[31, 31], file:"lib/stack.fy"}, ":pop":{doc:"

Pops the top-of-stack element from the Stack and returns it.

\n\n
Top-of-stack element.
\n\n", arg:[], lines:[43, 43], file:"lib/stack.fy"}, ":empty?":{doc:"

Indicates, if the Stack is empty.

\n\n
true if empty, otherwise false.
\n\n", arg:[], lines:[69, 69], file:"lib/stack.fy"}, ":<<":{doc:"

Pushes a value onto the Stack.

\n\n
Object to be pushed onto self.
\n\n", arg:["obj"], lines:[31, 31], file:"lib/stack.fy"}}}}}); })();