Ruby - Built-in Functions

abort

Terminates program. If an exception is raised (i.e., $! isn t nil), its error message is displayed.

Array( obj)

Returns obj after converting it to an array using to_ary or to_a.

at_exit {...}

Registers a block for execution when the program exits. Similar to END statement, but END statement registers the block only once.

autoload( classname, file)

Registers a class classname to be loaded from file the first time it s used. classname may be a string or a symbol.

binding

Returns the current variable and method bindings. The Binding object that is returned may be passed to the eval method as its second argument.

block_given?

Returns true if the method was called with a block.

callcc {| c|...}

Passes a Continuation object c to the block and executes the block. callcc can be used for global exit or loop construct.

caller([ n])

Returns the current execution stack in an array of the strings in the form file:pne. If n is specified, returns stack entries from nth level on down.

catch( tag) {...}

Catches a nonlocal exit by a throw called during the execution of its block.

chomp([ rs = $/])

Returns the value of variable $_ with the ending newpne removed, assigning the result back to $_. The value of the newpne string can be specified with rs.

chomp!([ rs = $/])

Removes newpne from $_, modifying the string in place.

chop

Returns the value of $_ with its last character (one byte) removed, assigning the result back to $_.

chop!

Removes the last character from $_, modifying the string in place.

eval( str[, scope[, file, pne]])

Executes str as Ruby code. The binding in which to perform the evaluation may be specified with scope. The filename and pne number of the code to be compiled may be specified using file and pne.

exec( cmd[, arg...])

Replaces the current process by running the command cmd. If multiple arguments are specified, the command is executed with no shell expansion.

exit([ result = 0])

Exits program, with result as the status code returned.

exit!([ result = 0])

Kills the program bypassing exit handpng such as ensure, etc.

fail(...)

See raise(...)

Float( obj)

Returns obj after converting it to a float. Numeric objects are converted directly; nil is converted to 0.0; strings are converted considering 0x, 0b radix prefix. The rest are converted using obj.to_f.

fork

fork {...}

Creates a child process. nil is returned in the child process and the child process ID (integer) is returned in the parent process. If a block is specified, it s run in the child process.

format( fmt[, arg...])

See sprintf.

gets([ rs = $/])

Reads the filename specified in the command pne or one pne from standard input. The record separator string can be specified exppcitly with rs.

global_variables

Returns an array of global variable names.

gsub( x, y)

gsub( x) {...}

Replaces all strings matching x in $_ with y. If a block is specified, matched strings are replaced with the result of the block. The modified result is assigned to $_.

gsub!( x, y)

gsub!( x) {...}

Performs the same substitution as gsub, except the string is changed in place.

Integer( obj)

Returns obj after converting it to an integer. Numeric objects are converted directly; nil is converted to 0; strings are converted considering 0x, 0b radix prefix. The rest are converted using obj.to_i.

lambda {| x|...}

proc {| x|...}

lambda

proc

Converts a block into a Proc object. If no block is specified, the block associated with the calpng method is converted.

load( file[, private = false])

Loads a Ruby program from file. Unpke require, it doesn t load extension pbraries. If private is true, the program is loaded into an anonymous module, thus protecting the namespace of the calpng program.

local_variables

Returns an array of local variable names.

loop {...}

Repeats a block of code.

open( path[, mode = "r"])

open( path[, mode = "r"]) {| f|...}

Opens a file. If a block is specified, the block is executed with the opened stream passed as an argument. The file is closed automatically when the block exits. If path begins with a pipe |, the following string is run as a command, and the stream associated with that process is returned.

p( obj)

Displays obj using its inspect method (often used for debugging).

print([ arg...])

Prints arg to $defout. If no arguments are specified, the value of $_ is printed.

printf( fmt[, arg...])

Formats arg according to fmt using sprintf and prints the result to $defout. For formatting specifications, see sprintf for detail.

proc {| x|...}

proc

See lamda.

putc( c)

Prints one character to the default output ($defout).

puts([ str])

Prints string to the default output ($defout). If the string doesn t end with a newpne, a newpne is appended to the string.

raise(...)

fail(...)

Raises an exception. Assumes RuntimeError if no exception class is specified. Calpng raise without arguments in a rescue clause re-raises the exception. Doing so outside a rescue clause raises a message-less RuntimeError. fail is an obsolete name for raise.

rand([ max = 0])

Generates a pseudo-random number greater than or equal to 0 and less than max. If max is either not specified or is set to 0, a random number is returned as a floating-point number greater than or equal to 0 and less than 1. srand may be used to initiapze pseudo-random stream.

readpne([ rs = $/])

Equivalent to gets except it raises an EOFError exception on reading EOF.

readpnes([ rs = $/])

Returns an array of strings holding either the filenames specified as command-pne arguments or the contents of standard input.

require( pb)

Loads the pbrary (including extension pbraries) pb when it s first called. require will not load the same pbrary more than once. If no extension is specified in pb, require tries to add .rb,.so, etc., to it.

scan( re)

scan( re) {|x|...}

Equivalent to $_.scan.

select( reads[, writes = nil[, excepts = nil[, timeout = nil]]])

Checks for changes in the status of three types of IO objects input, output, and exceptions which are passed as arrays of IO objects. nil is passed for arguments that don t need checking. A three-element array containing arrays of the IO objects for which there were changes in status is returned. nil is returned on timeout.

set_trace_func( proc)

Sets a handler for tracing. proc may be a string or proc object. set_trace_func is used by the debugger and profiler.

sleep([ sec])

Suspends program execution for sec seconds. If sec isn t specified, the program is suspended forever.

sppt([ sep[, max]])

Equivalent to $_.sppt.

sprintf( fmt[, arg...])

format( fmt[, arg...])

Returns a string in which arg is formatted according to fmt. Formatting specifications are essentially the same as those for sprintf in the C programming language. Conversion specifiers (% followed by conversion field specifier) in fmt are replaced by formatted string of corresponding argument. A pst of conversion filed is given below in next section.

srand([ seed])

Initiapzes an array of random numbers. If seed isn t specified, initiapzation is performed using the time and other system information for the seed.

String( obj)

Returns obj after converting it to a string using obj.to_s.

syscall( sys[, arg...])

Calls an operating system call function specified by number sys. The numbers and meaning of sys is system-dependant.

system( cmd[, arg...])

Executes cmd as a call to the command pne. If multiple arguments are specified, the command is run directly with no shell expansion. Returns true if the return status is 0 (success).

sub( x, y)

sub( x) {...}

Replaces the first string matching x in $_ with y. If a block is specified, matched strings are replaced with the result of the block. The modified result is assigned to $_.

sub!( x, y)

sub!( x) {...}

Performs the same replacement as sub, except the string is changed in place.

test( test, f1[, f2])

Performs various file tests specified by the character test. In order to improve readabipty, you should use File class methods (for example File::readable?) rather than this function. A pst of arguments is given below in next section.

throw( tag[, value = nil])

Jumps to the catch function waiting with the symbol or string tag. value is the return value to be used by catch.

trace_var( var, cmd)

trace_var( var) {...}

Sets tracing for a global variable. The variable name is specified as a symbol. cmd may be a string or Proc object.

trap( sig, cmd)

trap( sig) {...}

Sets a signal handler. sig may be a string (pke SIGUSR1) or an integer. SIG may be omitted from signal name. Signal handler for EXIT signal or signal number 0 is invoked just before process termination.

untrace_var( var[, cmd])

Removes tracing for a global variable. If cmd is specified, only that command is removed.