Standard library

The standard library is voluntarily small and minimal for this early release. As the language gains features and stabilizes, the right way to offer APIs will become more obvious, and the major use-cases of the language will be better known, allowing for better decisions regarding what makes sense to include in the stdlib.

There are currently six (6) stdlib modules:

• filepath to provide file path manipulation functions, a subset of Go's path/filepath package.
• fmt to provide formatted I/O, a subset of Go's fmt package.
• math to provide the usual mathematical functions, a subset of Go's math and math/rand packages.
• os to provide file access and process manipulation, a subset of Go's os, os/exec and io/ioutil packages.
• strings to provide string manipulation functions and regular expressions, a subset of Go's strings and regexp packages.
• time to provide date and time functions and types, a subset of Go's time package.

filepath

• Abs(val) : returns the absolute path of val. It may panic.
• Base(val) : returns the last element of val.
• Dir(val) : returns all but the last element of val.
• Ext(val) : returns the extension of the last element of val. The extension is the suffix of the last element starting at the last dot.
• IsAbs(val) : returns true if val is an absolute path.
• Join(vals...) : joins any number of path elements into a single path, and returns the resulting path.

fmt

• Print(vals...) : prints the vals to stdout.
• Println(vals...) : prints the vals to stdout, then prints a newline.
• Scanln() : reads text up to a newline character from stdin.
• Scanint() : reads and returns an integer value from stdin.

math

• Pi : number field that holds the Pi value.
• Abs(val) : returns the absolute value of val.
• Acos(val) : returns the arccosine of val.
• Acosh(val) : returns the inverse hyperbolic cosine of val.
• Asin(val) : returns the arcsine of val.
• Asinh(val) : returns the inverse hyperbolic sine of val.
• Atan(val) : returns the arctangent of val.
• Atan2(val1, val2) : returns the arctangent of val1/val2.
• Atanh(val) : returns the inverse hyperbolic tangent of val.
• Ceil(val) : returns the ceiling of val.
• Cos(val) : returns the cosine of val.
• Cosh(val) : returns the hyperbolic cosine of val.
• Exp(val) : returns the base-e exponential of val.
• Floor(val) : returns the floor of val.
• Inf(val) : returns positive infinity if val >= 0, negative infinity otherwise.
• IsInf(val1, val2) : returns true if val1 is infinity according to the sign of val2.
• IsNaN(val) : returns true if val is not a number (NaN).
• Max(vals...) : returns the maximum value of all vals.
• Min(vals...) : returns the minimum value of all vals.
• NaN() : returns the not-a-number (NaN) value.
• Pow(val1, val2) : returns the base-val1 exponential of val2.
• Sin(val) : returns the sine of val.
• Sinh(val) : returns the hyperbolic sine of val.
• Sqrt(val) : returns the square root of val.
• Tan(val) : returns the tangent of val.
• Tanh(val) : returns the hyperbolic tangent of val.
• RandSeed(val) : initializes the random generator with the val seed.
• Rand([val1[, val2]]) : returns a random value >= 0. If val1 is provided, it is used as the higher bound. If both val1 and val2 are provided, val1 is the inclusive lower bound, val2 is the higher bound.

os

• TempDir : string field that holds the temporary directory.
• PathSeparator : string field that holds the path separator.
• PathListSeparator : string field that holds the path list separator.
• DevNull : string field that holds the name of the OS's null device.
• Exit([val]) : terminates the current process with the val exit code, or 0 if no val is specified.
• Getenv(val) : returns the environment variable identified by val.
• Getwd() : returns the current working directory.
• Exec(val[, vals]) : executes the process identified by val, with vals as arguments. Returns the combined stdout and stderr output as a string.
• Mkdir(vals...) : creates all directories as specified by vals, creating missing subdirectories as required. If the last argument is a number, it is used as the permission flag, otherwise all directories are created with the 0777 permission.
• ReadDir(val) : reads all files and subdirectories in val, and returns an array-like object holding all those files and subdirectories.
• Remove(vals...) : removes all directories specified by vals.
• RemoveAll(vals...) : removes all directories and their content specified by vals.
• Rename(val1, val2) : renames the file or directory identified by val1 to val2.
• ReadFile(val) : reads the content of the file identified by val and returns it as a string.
• WriteFile(val, vals...) : creates a new file or replace an existing file identified by val, and writes all vals to this file. Returns the number of bytes writte.
• Open(val1[, val2]) : opens the file identified by val1, by default in read-only mode. If a second argument is provided, it is the open mode, one of r, w, a, r+, w+ or a+.
• TryOpen(val1[, val2]) : same as Open, but returns nil instead of a runtime error if there is an error opening the file.

ReadFile returns an array-like object that holds objects with the following fields:

• Name : the name of the file or directory.
• Size : the size in bytes of the file.
• IsDir : a boolean indicating if the item is a directory.

Open and TryOpen return an object with the following fields:

• Name : a string field that holds the base name of the file.
• Close() : a method to close the file resource.
• ReadLine() : a method that reads a single line from the file and returns it. It returns nil if there are no more lines to read.
• Seek(val1, val2) : sets the current position to read or write to the file to the offset specified by val1. If val2 is specified, it is the relative position - 0 for start of the file, 1 for current position, and 2 for end of the file.
• Write(vals...) : writes the vals to the file and returns the number of bytes returned.
• WriteLine(vals...) : like Write, but appends a newline after vals are written to the file.

strings

• ByteAt(s, i) : returns the byte at position i in string s, as a string value. It returns an empty string if i is out of bounds.
• Concat(vals...) : concatenates all vals in order and returns the resulting string.
• Contains(val, vals...) : returns true if val contains any of the vals.
• HasPrefix(val, vals...) : checks if val starts with any of the vals, returning true if this is the case.
• HasSuffix(val, vals...) : checks if val ends with any of the vals, returning true if this is the case.
• Index(s[, start], vals...) : returns the index of the first of vals found within s. If start is specified, looks for vals starting at index start in s.
• Join(ob[, sep]) : takes an array-like object and joins each part using the separator sep, or empty string by default. Returns the resulting string.
• LastIndex(val[, start], vals...) : same as Index but returns the last index of vals instead of the first encounter.
• Matches(s, pat[, n]) : returns the matches of regular expression pat applied to the source string s. If n is provided, a maximum of n matches are returned. The return value is an array-like object holding all matches or nil if there is none (see the match object definition below).
• Repeat(s, n) : returns a string consisting of n times the string s.
• Replace(s, old[, new][, n]) : replaces occurrences of old in s with new, or empty string if new is not provided. If n is provided, replaces a maximum of n occurrences. If the third argument is a number, it is considered to be n and new defaults to empty string.
• Slice(s, start[, end]) : returns a slice of string s start at start and ending at end (or the end of s if end is not provided). Is equivalent to Go's s[start:end] notation.
• Split(s, sep[, n]) : returns an array-like object holding the parts of string s split at separator sep. If n is provided, a maximum of n parts are returned, the last part holding the rest of s if required.
• ToLower(vals...) : converts and concatenates all vals to lowercase, and returns the resulting string.
• ToUpper(vals...) : converts and concatenates all vals to uppercase, and returns the resulting string.
• Trim(s[, cut]) : returns a string with all characters from cut removed from the start and the end of s. If cut is not provided, removes whitespace (space, \n, \t, \r, \v).

A match object is an array-like object holding the match groups, with group 0 being the full match. Each match group has the following fields:

• Start : the index of the start of the match.
• End : the index of the end of the match.
• Text : the text of the match.

time

• Date(year[, month[, day[, hour[, min[, sec[, ns]]]]]]) : returns a time object (see definition below) corresponding to the requested time. Month and day default to 1 if not provided, while hour, minute, second and nanosecond default to 0.
• Now() : returns a time object (see definition below) corresponding to the current time.
• Sleep(ms) : pauses execution of the agora program for the specified number of milliseconds. It returns nil.

The time object provides the following fields and operations:

• Year : holds the year part of the time.
• Month : holds the month part of the time.
• Day : holds the day part of the time.
• Hour : holds the hour part of the time.
• Minute : holds the minute part of the time.
• Second : holds the second part of the time.
• Nanosecond : holds the nanosecond part of the time.
• __int : overrides the integer conversion, returns the Unix time, which is the number of seconds since January 1, 1970 UTC.
• __string : overrides the string conversion, formats the time in RFC3339 format.

Next: Command-line tool