A · Built-in API

On this page

Every signature below comes from the current compiler’s public API. Overloads share a heading. BYREF requires exclusive writable access; TAKE transfers ownership; FAILS lists checked errors. See the teaching chapters and library references for behavior and examples.

ABS

FUNCTION ABS(value AS DOUBLE) AS DOUBLE
FUNCTION ABS(value AS INTEGER) AS INTEGER FAILS NumericError

AbsDuration

FUNCTION AbsDuration(value AS Duration) AS Duration FAILS DateTimeError

Accept

FUNCTION Accept(listener AS TCPListener) AS TCPConnection FAILS IoError
FUNCTION Accept(listener AS TCPListener,timeout AS Duration) AS TCPConnection FAILS IoError

ACOS

FUNCTION ACOS(value AS DOUBLE) AS DOUBLE

ACOSH

FUNCTION ACOSH(value AS DOUBLE) AS DOUBLE

Add

FUNCTION Add[T](BYREF c AS Counter[T],key AS T,amount AS INTEGER=1) AS INTEGER FAILS CollectionError,LIKE ValidateKey(AS T)
SUB Add[K,V](BYREF m AS MultiMap[K,V],key AS K,BYVAL value AS V) FAILS CollectionError,MissingKey,LIKE ValidateKey(AS K)

AddDays

FUNCTION AddDays(value AS Date,days AS INTEGER) AS Date FAILS DateTimeError

AddDuration

FUNCTION AddDuration(left AS Duration,right AS Duration) AS Duration FAILS DateTimeError
FUNCTION AddDuration(value AS Instant,amount AS Duration) AS Instant FAILS DateTimeError
FUNCTION AddDuration(value AS OffsetDateTime,amount AS Duration) AS OffsetDateTime FAILS DateTimeError
FUNCTION AddDuration(value AS ZonedDateTime,amount AS Duration) AS ZonedDateTime FAILS DateTimeError

AddFont

SUB AddFont(BYREF fonts AS FontSet,BYVAL font AS Font) FAILS CanvasError

AddFontFile

SUB AddFontFile(BYREF fonts AS FontSet,path AS STRING,maxBytes AS INTEGER=33554432,faceIndex AS INTEGER=0) FAILS CanvasError,IndexError,NumericError,IoError

AddLogSink

SUB AddLogSink(logger AS Logger,BYVAL sink AS LogSink) FAILS LoggingError
SUB AddLogSink(logger AS LoggerHandle,BYVAL sink AS LogSink) FAILS LoggingError
SUB AddLogSink(BYVAL sink AS LogSink) FAILS LoggingError
SUB AddLogSink(logger AS Logger,handler AS CALLABLE(LogRecord) FAILS (Error)) FAILS LoggingError
SUB AddLogSink(logger AS LoggerHandle,handler AS CALLABLE(LogRecord) FAILS (Error)) FAILS LoggingError
SUB AddLogSink(handler AS CALLABLE(LogRecord) FAILS (Error)) FAILS LoggingError
SUB AddLogSink[T](logger AS Logger,BYVAL context AS T,handler AS CALLABLE(T,LogRecord) FAILS (Error)) FAILS LoggingError
SUB AddLogSink[T](logger AS Logger,BYVAL context AS T,handler AS CALLABLE(BYREF T,LogRecord) FAILS (Error)) FAILS LoggingError
SUB AddLogSink[T](logger AS LoggerHandle,BYVAL context AS T,handler AS CALLABLE(T,LogRecord) FAILS (Error)) FAILS LoggingError
SUB AddLogSink[T](logger AS LoggerHandle,BYVAL context AS T,handler AS CALLABLE(BYREF T,LogRecord) FAILS (Error)) FAILS LoggingError
SUB AddLogSink[T](BYVAL context AS T,handler AS CALLABLE(T,LogRecord) FAILS (Error)) FAILS LoggingError
SUB AddLogSink[T](BYVAL context AS T,handler AS CALLABLE(BYREF T,LogRecord) FAILS (Error)) FAILS LoggingError

AddMonths

FUNCTION AddMonths(value AS Date,months AS INTEGER,overflow AS DateOverflow=DateOverflow.Reject) AS Date FAILS DateTimeError

AddNominalDuration

FUNCTION AddNominalDuration(value AS LocalDateTime,amount AS Duration) AS LocalDateTime FAILS DateTimeError

AddPeriod

FUNCTION AddPeriod(value AS Date,amount AS Period,overflow AS DateOverflow=DateOverflow.Reject) AS Date FAILS DateTimeError
FUNCTION AddPeriod(value AS LocalDateTime,amount AS Period,overflow AS DateOverflow=DateOverflow.Reject) AS LocalDateTime FAILS DateTimeError
FUNCTION AddPeriod(value AS ZonedDateTime,amount AS Period,options AS CalendarAddOptions) AS ZonedDateTime FAILS DateTimeError

AddPeriods

FUNCTION AddPeriods(left AS Period,right AS Period) AS Period FAILS DateTimeError

AddURLQueryParameter

SUB AddURLQueryParameter(BYREF parameters AS LIST OF URLParameter,name AS STRING,value AS STRING)
SUB AddURLQueryParameter(BYREF value AS URL,name AS STRING,text AS STRING) FAILS UrlError

AddWeeks

FUNCTION AddWeeks(value AS Date,weeks AS INTEGER) AS Date FAILS DateTimeError

AddYears

FUNCTION AddYears(value AS Date,years AS INTEGER,overflow AS DateOverflow=DateOverflow.Reject) AS Date FAILS DateTimeError

AdjustedCanvas

FUNCTION AdjustedCanvas(canvas AS Canvas,brightness AS DOUBLE=1.0,contrast AS DOUBLE=1.0,saturation AS DOUBLE=1.0,gamma AS DOUBLE=1.0) AS Canvas FAILS CanvasError,IndexError,NumericError

AdjustTestWallClock

SUB AdjustTestWallClock(BYREF clock AS Clock,adjustment AS Duration) FAILS DateTimeError

AdvanceTestClock

SUB AdvanceTestClock(BYREF clock AS Clock,elapsed AS Duration) FAILS DateTimeError

All

FUNCTION All[T](items AS LIST OF T,Predicate AS CALLABLE(T) AS BOOLEAN) AS BOOLEAN
FUNCTION All[T](items AS SET OF T,Predicate AS CALLABLE(T) AS BOOLEAN) AS BOOLEAN
FUNCTION All[K,V](items AS DICT OF K TO V,Predicate AS CALLABLE(K,V) AS BOOLEAN) AS BOOLEAN

AlphaBounds

FUNCTION AlphaBounds(canvas AS Canvas,threshold AS INTEGER=0) AS OPTIONAL OF PixelRect FAILS CanvasError,IndexError,NumericError

AnalyzeCanvas

FUNCTION AnalyzeCanvas(canvas AS Canvas) AS ImageStatistics FAILS CanvasError,IndexError

AnalyzeCanvasRegion

FUNCTION AnalyzeCanvasRegion(canvas AS Canvas,region AS PixelRect) AS ImageStatistics FAILS CanvasError,IndexError

AnimationDelayDenominator

FUNCTION AnimationDelayDenominator(animation AS Animation,index AS INTEGER) AS INTEGER FAILS CanvasError,IndexError

AnimationDelayNumerator

FUNCTION AnimationDelayNumerator(animation AS Animation,index AS INTEGER) AS INTEGER FAILS CanvasError,IndexError

AnimationFrame

FUNCTION AnimationFrame(animation AS Animation,index AS INTEGER) AS Canvas FAILS CanvasError,IndexError

AnimationFrameCount

FUNCTION AnimationFrameCount(animation AS Animation) AS INTEGER

AnimationFrameDelay

FUNCTION AnimationFrameDelay(animation AS Animation,index AS INTEGER) AS Duration FAILS CanvasError,IndexError

AnimationHeight

FUNCTION AnimationHeight(animation AS Animation) AS INTEGER

AnimationPlays

FUNCTION AnimationPlays(animation AS Animation) AS INTEGER

AnimationWidth

FUNCTION AnimationWidth(animation AS Animation) AS INTEGER

Any

FUNCTION Any[T](items AS LIST OF T,Predicate AS CALLABLE(T) AS BOOLEAN) AS BOOLEAN
FUNCTION Any[T](items AS SET OF T,Predicate AS CALLABLE(T) AS BOOLEAN) AS BOOLEAN
FUNCTION Any[K,V](items AS DICT OF K TO V,Predicate AS CALLABLE(K,V) AS BOOLEAN) AS BOOLEAN

Append

FUNCTION Append[T](BYREF items AS LIST OF T,BYVAL value AS T) AS INTEGER
FUNCTION Append(BYREF buffer AS ByteBuffer,value AS BYTE) AS INTEGER
FUNCTION Append(BYREF builder AS StringBuilder,text AS STRING) AS INTEGER

AppendAnimationFrame

SUB AppendAnimationFrame(BYREF animation AS Animation,canvas AS Canvas,delayNumerator AS INTEGER,delayDenominator AS INTEGER=1000) FAILS CanvasError

AppendChar

FUNCTION AppendChar(BYREF builder AS StringBuilder,scalar AS INTEGER) AS INTEGER FAILS StringError

AppendLine

FUNCTION AppendLine(BYREF builder AS StringBuilder,text AS STRING="") AS INTEGER

AppendUInt64LE

FUNCTION AppendUInt64LE(BYREF bytes AS LIST OF BYTE,value AS UINT64) AS INTEGER

ApplyAmount

FUNCTION ApplyAmount(value AS LocalDateTime,amount AS DateTimeAmount,overflow AS DateOverflow=DateOverflow.Reject) AS LocalDateTime FAILS DateTimeError
FUNCTION ApplyAmount(value AS ZonedDateTime,amount AS DateTimeAmount,options AS CalendarAddOptions) AS ZonedDateTime FAILS DateTimeError

ArgumentBoolean

FUNCTION ArgumentBoolean(value AS BOOLEAN) AS ArgumentValue

ArgumentInteger

FUNCTION ArgumentInteger(value AS INTEGER) AS ArgumentValue

ArgumentOptions

FUNCTION ArgumentOptions[T](parsed AS ParsedArguments) AS T FAILS ArgumentError

ArgumentReal

FUNCTION ArgumentReal(value AS DOUBLE) AS ArgumentValue

ArgumentText

FUNCTION ArgumentText(value AS STRING) AS ArgumentValue

ASC

FUNCTION ASC(text AS STRING) AS INTEGER FAILS StringError

ASIN

FUNCTION ASIN(value AS DOUBLE) AS DOUBLE

ASINH

FUNCTION ASINH(value AS DOUBLE) AS DOUBLE

At

FUNCTION At[T](s AS SortedSet[T],index AS INTEGER) AS T FAILS IndexError

ATAN

FUNCTION ATAN(input AS DOUBLE) AS DOUBLE

ATAN2

FUNCTION ATAN2(y AS DOUBLE, x AS DOUBLE) AS DOUBLE

ATANH

FUNCTION ATANH(value AS DOUBLE) AS DOUBLE

AtDay

FUNCTION AtDay(value AS YearMonth,day AS INTEGER) AS Date FAILS DateTimeError

ATN

FUNCTION ATN(value AS DOUBLE) AS DOUBLE

AtOffset

FUNCTION AtOffset(value AS Instant,offset AS UtcOffset) AS OffsetDateTime FAILS DateTimeError

AtYear

FUNCTION AtYear(value AS MonthDay,year AS INTEGER,overflow AS DateOverflow=DateOverflow.Reject) AS Date FAILS DateTimeError

AtZone

FUNCTION AtZone(value AS Instant,zone AS TimeZone) AS ZonedDateTime FAILS DateTimeError

AverageColor

FUNCTION AverageColor(canvas AS Canvas,alphaWeighted AS BOOLEAN=FALSE) AS Color FAILS CanvasError,IndexError,NumericError

Find your way around BASIL

Type to search the manual.