Fantom

 

pod

sys

Fantom system runtime

Mixins

Facet Facet is a mixin includes into every facet type.
Service Services are used to publish functionality in a VM for use by other software components.

Classes

Bool Bool represents a boolean condition of true or false.
Buf Buf is used to model a block of bytes with random access.
Charset Charset represents a specific character encoding used to decode bytes to Unicode characters, and encode Unicode characters to bytes.
Date Date represents a day in time independent of a timezone.
DateTime DateTime represents an absolute instance in time.
Decimal Decimal is used to represent a decimal floating point more precisely than a Float.
Depend Depend models a dependency as a pod name and a version constraint.
Duration Duration represents a relative duration of time with nanosecond precision.
Enum Enum is the base class for enum classes defined using the enum keyword.
Env Env defines a pluggable class used boot and manage a Fantom runtime environment.
Field Field is a slot which models the ability to get and set a value.
File File is used to represent a Uri path to a file or directory.
Float Float is used to represent a 64-bit floating point number.
Func Func models an executable function.
InStream InStream is used to read binary and text stream based input.
Int Int is used to represent a signed 64-bit integer.
List List represents an liner sequence of Objects indexed by an Int.
Locale Locale models a cultural language and region/country.
Log Log provides a simple, but standardized mechanism for logging.
LogRec LogRec all the information of a single logging event.
Map Map is a hash map of key/value pairs.
Method Method models a function with a formal parameter list and return value (or Void if no return).
MimeType MimeType represents the parsed value of a Content-Type header per RFC 2045 section 5.1.
Num Num is the base class for number classes: Int, Float, and Decimal.
Obj Obj is the root class of all classes.
OutStream OutStream is used to write binary and text data to an output stream.
Param Param represents one parameter definition of a Func (or Method).
Pod Pod represents a module of Types.
Process Process manages spawning external OS processes.
Range Range represents a contiguous range of integers from start to end.
Regex Regex represents a regular expression.
RegexMatcher RegexMatcher is used to matching operations on a regular expression.
Slot Slot represents a member field or method on a Type.
Str Str represents a sequence of Unicode characters.
StrBuf StrBuf is a mutable sequence of Int characters.
Test Test is the base for Fantom unit tests.
This This represents a method return type which is always this type.
Time Time represents a time of day independent of a specific date or timezone.
TimeZone TimeZone represents a region's offset from UTC and its daylight savings time rules.
Type Type defines the contract of an Obj by the slots its supports.
Unit Unit models a unit of measurement.
Unsafe Unsafe is used to wrap a non-const mutable objects so that it can be passed as an immutable reference.
Uri Uri is used to immutably represent a Universal Resource Identifier according to RFC 3986.
UriScheme UriSchemes are registered to handle a specific Uri scheme such as "file" or "http".
Uuid Universally Unique Identifier.
Version Version is defined as a list of decimal digits separated by the dot.
Void Void is used to represent the absence of a return value in a Method.
Zip Zip is used to read/write compressed zip files and streams.

Enums

Endian Byte ordering.
LogLevel LogLevel provides a set of discrete levels used to customize logging.
Month Enum for twelve months of the year.
Weekday Enum for seven days of the week.

Facets

Deprecated Indicates that a type or slot is obsolete
Js Used to annoate types which should be compiled into JavaScript.
NoDoc This facet is used on public types and slots to indicate they should not be documented with automated tools such as Fandoc.
Serializable Serializable is a facet used to annotate types which can be serialized.
Transient Transient is a facet used to annotate fields which should be serialized inside a Serializable type.

Errs

ArgErr ArgErr indicates an invalid argument was passed.
CancelledErr CancelledErr indicates that an operation was cancelled before it complete normally.
CastErr CastErr is a runtime exception raised when invalid cast is performed.
ConstErr ConstErr indicates an attempt to set a const field after the object has been constructed.
Err Err is the base class of all exceptions.
FieldNotSetErr FieldNotSetErr indicates a non-nullable field was not set by the constructor it-block.
IndexErr IndexErr indicates an attempt to access an invalid index in a List.
InterruptedErr InterruptedErr indicates that a thread is interrupted from its normal execution.
IOErr IOErr indicates an input/output error typically associated with a file system or socket.
NameErr NameErr indicates an attempt use an invalid name.
NotImmutableErr NotImmutableErr indicates using a mutable Obj where an immutable Obj is required.
NullErr NullErr is a runtime exception raised when using a null reference or when null is passed for a method argument which must be non-null.
ParseErr ParseErr indicates an invalid string format which cannot be parsed.
ReadonlyErr ReadonlyErr indicates an attempt to modify a readonly instance; it is commonly used with List and Map.
TimeoutErr TimeoutErr indicates that a blocking operation timed out before normal completion.
UnknownFacetErr UnknownFacetErr indicates an attempt to access a undefined facet.
UnknownPodErr UnknownPodErr indicates an attempt to access a non-existent pod.
UnknownServiceErr UnknownServiceErr indicates an attempt to lookup an service not installed.
UnknownSlotErr UnknownSlotErr indicates an attempt to access a non-existent slot.
UnknownTypeErr UnknownTypeErr indicates an attempt to access a non-existent type.
UnresolvedErr UnresolvedErr indicates the failure to resolve a Uri to a resource.
UnsupportedErr UnsupportedErr indicates a feature which isn't supported.