C · 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.

CacheCapacity

FUNCTION CacheCapacity[K,V](cache AS Cache[K,V]) AS INTEGER

CacheCount

FUNCTION CacheCount[K,V](BYREF cache AS Cache[K,V]) AS INTEGER FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K)

CacheCountAt

FUNCTION CacheCountAt[K,V](BYREF cache AS Cache[K,V],now AS MonotonicInstant) AS INTEGER FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K)

CacheExtract

FUNCTION CacheExtract[K,V](BYREF cache AS Cache[K,V],key AS K) AS OPTIONAL OF V FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K)

CacheExtractAt

FUNCTION CacheExtractAt[K,V](BYREF cache AS Cache[K,V],key AS K,now AS MonotonicInstant) AS OPTIONAL OF V FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K)

CacheFind

FUNCTION CacheFind[K,V](BYREF cache AS Cache[K,V],key AS K) AS OPTIONAL OF V FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K) WHERE V IS COPYABLE
FUNCTION CacheFind[K,V](BYREF cache AS Cache[K,V],key AS K) AS BORROW OPTIONAL OF V FROM cache FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K) WHERE V IS RESOURCE

CacheFindAt

FUNCTION CacheFindAt[K,V](BYREF cache AS Cache[K,V],key AS K,now AS MonotonicInstant) AS OPTIONAL OF V FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K) WHERE V IS COPYABLE
FUNCTION CacheFindAt[K,V](BYREF cache AS Cache[K,V],key AS K,now AS MonotonicInstant) AS BORROW OPTIONAL OF V FROM cache FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K) WHERE V IS RESOURCE

CachePeek

FUNCTION CachePeek[K,V](cache AS Cache[K,V],key AS K) AS OPTIONAL OF V FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K) WHERE V IS COPYABLE
FUNCTION CachePeek[K,V](cache AS Cache[K,V],key AS K) AS BORROW OPTIONAL OF V FROM cache FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K) WHERE V IS RESOURCE

CachePeekAt

FUNCTION CachePeekAt[K,V](cache AS Cache[K,V],key AS K,now AS MonotonicInstant) AS OPTIONAL OF V FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K) WHERE V IS COPYABLE
FUNCTION CachePeekAt[K,V](cache AS Cache[K,V],key AS K,now AS MonotonicInstant) AS BORROW OPTIONAL OF V FROM cache FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K) WHERE V IS RESOURCE

CachePut

FUNCTION CachePut[K,V](BYREF cache AS Cache[K,V],key AS K,BYVAL value AS V,weight AS INTEGER=1) AS CachePutResult FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K)

CachePutAt

FUNCTION CachePutAt[K,V](BYREF cache AS Cache[K,V],key AS K,BYVAL value AS V,now AS MonotonicInstant,weight AS INTEGER=1) AS CachePutResult FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K)

CacheRemove

FUNCTION CacheRemove[K,V](BYREF cache AS Cache[K,V],key AS K) AS BOOLEAN FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K)

CacheRemoveAt

FUNCTION CacheRemoveAt[K,V](BYREF cache AS Cache[K,V],key AS K,now AS MonotonicInstant) AS BOOLEAN FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K)

CacheWeightLimit

FUNCTION CacheWeightLimit[K,V](cache AS Cache[K,V]) AS INTEGER

CalendarBetween

FUNCTION CalendarBetween(start AS Date,finish AS Date,largestUnit AS CalendarDifferenceUnit=CalendarDifferenceUnit.Day,overflow AS DateOverflow=DateOverflow.Reject) AS Period FAILS DateTimeError

CanDecodeAnimation

FUNCTION CanDecodeAnimation(format AS ImageFormat) AS BOOLEAN

CanDecodeImage

FUNCTION CanDecodeImage(format AS ImageFormat) AS BOOLEAN

CanEncodeAnimation

FUNCTION CanEncodeAnimation(format AS ImageFormat) AS BOOLEAN

CanEncodeImage

FUNCTION CanEncodeImage(format AS ImageFormat) AS BOOLEAN

CanonicalPath

FUNCTION CanonicalPath(path AS STRING) AS STRING FAILS IoError

CanvasBytes

FUNCTION CanvasBytes(canvas AS Canvas) AS LIST OF BYTE

CanvasFromRGBA

FUNCTION CanvasFromRGBA(width AS INTEGER,height AS INTEGER,BYVAL pixels AS LIST OF BYTE,maxPixels AS INTEGER=16777216) AS Canvas FAILS CanvasError,NumericError,IndexError

CanvasHeight

FUNCTION CanvasHeight(canvas AS Canvas) AS INTEGER

CanvasWidth

FUNCTION CanvasWidth(canvas AS Canvas) AS INTEGER

Capacity

FUNCTION Capacity[T](q AS BoundedDeque[T]) AS INTEGER
FUNCTION Capacity(bits AS BitSet) AS INTEGER
FUNCTION Capacity(buffer AS ByteBuffer) AS INTEGER
FUNCTION Capacity(builder AS StringBuilder) AS INTEGER
FUNCTION Capacity(writer AS ByteWriter) AS INTEGER
FUNCTION Capacity[T](reader AS BufferedReader[T]) AS INTEGER WHERE T IS RESOURCE

CASEFOLD

FUNCTION CASEFOLD(text AS STRING) AS STRING

CBRT

FUNCTION CBRT(value AS DOUBLE) AS DOUBLE

CBYTE

FUNCTION CBYTE(value AS INTEGER) AS BYTE FAILS NumericError
FUNCTION CBYTE(value AS UINT64) AS BYTE FAILS NumericError

CDBL

FUNCTION CDBL(value AS UINT64) AS DOUBLE
FUNCTION CDBL(value AS BYTE) AS DOUBLE
FUNCTION CDBL(value AS UINT32) AS DOUBLE
FUNCTION CDBL(value AS INTEGER) AS DOUBLE
FUNCTION CDBL(value AS DOUBLE) AS DOUBLE
FUNCTION CDBL(input AS STRING) AS DOUBLE FAILS NumericError

CEIL

FUNCTION CEIL(value AS DOUBLE) AS DOUBLE

CEILING

FUNCTION CEILING(value AS DOUBLE) AS DOUBLE

CHR

FUNCTION CHR(value AS INTEGER) AS STRING FAILS StringError

CINT

FUNCTION CINT(value AS UINT64) AS INTEGER FAILS NumericError
FUNCTION CINT(value AS BYTE) AS INTEGER
FUNCTION CINT(value AS UINT32) AS INTEGER
FUNCTION CINT(value AS INTEGER) AS INTEGER
FUNCTION CINT(value AS DOUBLE) AS INTEGER FAILS NumericError

CLAMP

FUNCTION CLAMP(value AS DOUBLE, lower AS DOUBLE, upper AS DOUBLE) AS DOUBLE
FUNCTION CLAMP(value AS INTEGER, lower AS INTEGER, upper AS INTEGER) AS INTEGER FAILS MathError

Clear

FUNCTION Clear[T](BYREF items AS LIST OF T) AS INTEGER
FUNCTION Clear[K](BYREF items AS SET OF K) AS INTEGER
FUNCTION Clear[K,V](BYREF items AS DICT OF K TO V) AS INTEGER
SUB Clear(BYREF buffer AS ByteBuffer)
SUB Clear(BYREF builder AS StringBuilder)
SUB Clear(BYREF writer AS ByteWriter)

ClearCanvas

SUB ClearCanvas(BYREF canvas AS Canvas,color AS Color) FAILS IndexError

ClearLogSinks

SUB ClearLogSinks(logger AS Logger) FAILS LoggingError
SUB ClearLogSinks(logger AS LoggerHandle) FAILS LoggingError
SUB ClearLogSinks() FAILS LoggingError

CloneCanvas

FUNCTION CloneCanvas(canvas AS Canvas) AS Canvas

ClonePath

FUNCTION ClonePath(path AS CanvasPath) AS CanvasPath

Close

FUNCTION Close(file AS File) AS INTEGER FAILS IoError
FUNCTION Close(socket AS TCPListener) AS INTEGER FAILS IoError
FUNCTION Close(socket AS TCPConnection) AS INTEGER FAILS IoError
FUNCTION Close(terminal AS Terminal) AS INTEGER FAILS IoError
FUNCTION Close(db AS DATABASE) AS INTEGER FAILS SqliteError
FUNCTION Close[T](port AS SENDER OF T) AS INTEGER
FUNCTION Close(logger AS Logger) AS INTEGER FAILS LoggingError
FUNCTION Close(logger AS LoggerHandle) AS INTEGER FAILS LoggingError

ClosePath

SUB ClosePath(BYREF path AS CanvasPath) FAILS CanvasError

CloseProcessInput

FUNCTION CloseProcessInput(process AS Process) AS INTEGER FAILS IoError

CloseRead

FUNCTION CloseRead(socket AS TCPConnection) AS INTEGER FAILS IoError

CloseWrite

FUNCTION CloseWrite(socket AS TCPConnection) AS INTEGER FAILS IoError

CODEPOINTS

FUNCTION CODEPOINTS(text AS STRING) AS LIST OF INTEGER

ColorBounds

FUNCTION ColorBounds(canvas AS Canvas,minimum AS Color,maximum AS Color) AS OPTIONAL OF PixelRect FAILS CanvasError,IndexError

CommandFlag

FUNCTION CommandFlag(name AS STRING,short AS STRING="",description AS STRING="",global AS BOOLEAN=FALSE) AS CommandOption

CommandLineArguments

FUNCTION CommandLineArguments() AS LIST OF STRING FAILS IoError

CommandLineParameters

FUNCTION CommandLineParameters() AS LIST OF STRING FAILS IoError

CommandOptions

FUNCTION CommandOptions[T](defaults AS T) AS Command FAILS ArgumentError,StringError

Compare

FUNCTION Compare[T](left AS T, right AS T) AS CompareResult

CompareCaseInsensitive

FUNCTION CompareCaseInsensitive(left AS STRING, right AS STRING) AS CompareResult

CompareDate

FUNCTION CompareDate(left AS Date,right AS Date) AS INTEGER

CompareInstant

FUNCTION CompareInstant(left AS Instant,right AS Instant) AS INTEGER

CompareLocalDateTime

FUNCTION CompareLocalDateTime(left AS LocalDateTime,right AS LocalDateTime) AS INTEGER

CompareMonotonic

FUNCTION CompareMonotonic(left AS MonotonicInstant,right AS MonotonicInstant) AS CompareResult FAILS DateTimeError

CompareTime

FUNCTION CompareTime(left AS TimeOfDay,right AS TimeOfDay) AS INTEGER

CompileDateTimePattern

FUNCTION CompileDateTimePattern(pattern AS STRING,target AS PatternTarget) AS DateTimePattern FAILS DateTimeError

CompileRegex

FUNCTION CompileRegex(pattern AS STRING,Flags AS STRING="",Dialect AS RegexDialect=RegexDialect.Native,Limits AS RegexLimits=RegexLimits {}) AS Regex FAILS RegexError

Complement

FUNCTION Complement(bits AS BitSet) AS BitSet

ComposeTransforms

FUNCTION ComposeTransforms(first AS AffineTransform,after AS AffineTransform) AS AffineTransform FAILS CanvasError

CompositeColor

FUNCTION CompositeColor(source AS Color,destination AS Color,opacity AS DOUBLE=1.0,mode AS BlendMode=BlendMode.SourceOver,space AS BlendSpace=BlendSpace.EncodedSRGB) AS Color FAILS CanvasError,NumericError

Concat

FUNCTION Concat[T](left AS LIST OF T, right AS LIST OF T) AS LIST OF T

ConnectHTTP

FUNCTION ConnectHTTP(url AS HTTPURL,options AS HTTPClientOptions) AS TCPConnection FAILS IoError,TLSError,IndexError

Contains

FUNCTION Contains(value AS JsonValue,key AS STRING) AS BOOLEAN FAILS JsonError
FUNCTION Contains(value AS DateInterval,date AS Date) AS BOOLEAN
FUNCTION Contains(value AS InstantInterval,instant AS Instant) AS BOOLEAN
FUNCTION Contains[T](items AS LIST OF T, value AS T) AS BOOLEAN
FUNCTION Contains[K](table AS SET OF K, key AS K) AS BOOLEAN FAILS LIKE ValidateKey(AS K)
FUNCTION Contains[K,V](table AS DICT OF K TO V, key AS K) AS BOOLEAN FAILS LIKE ValidateKey(AS K)

CONTAINS

FUNCTION CONTAINS(text AS STRING, needle AS STRING) AS BOOLEAN

ContainsValue

FUNCTION ContainsValue[K,V](table AS DICT OF K TO V, value AS V) AS BOOLEAN

ConvolveCanvas3x3

FUNCTION ConvolveCanvas3x3(canvas AS Canvas,kernel AS LIST OF DOUBLE,divisor AS DOUBLE=1.0,bias AS DOUBLE=0.0) AS Canvas FAILS CanvasError,IndexError,NumericError

COPYSIGN

FUNCTION COPYSIGN(value AS DOUBLE, sign AS DOUBLE) AS DOUBLE

CopyWithin

FUNCTION CopyWithin[T](BYREF items AS LIST OF T, source AS INTEGER, destination AS INTEGER, count AS INTEGER) AS INTEGER FAILS IndexError
FUNCTION CopyWithin(BYREF bytes AS LIST OF BYTE,source AS INTEGER,destination AS INTEGER,count AS INTEGER) AS INTEGER FAILS IndexError

CopyWithinCanvas

SUB CopyWithinCanvas(BYREF canvas AS Canvas,source AS PixelRect,x AS INTEGER,y AS INTEGER,opacity AS DOUBLE=1.0,mode AS BlendMode=BlendMode.Copy) FAILS CanvasError,IndexError,NumericError

COS

FUNCTION COS(value AS DOUBLE) AS DOUBLE

COSH

FUNCTION COSH(value AS DOUBLE) AS DOUBLE

CosineSimilarity

FUNCTION CosineSimilarity(left AS LIST OF DOUBLE,right AS LIST OF DOUBLE) AS DOUBLE FAILS VectorDimensionError,ZeroVectorError
FUNCTION CosineSimilarity(left AS LIST OF INTEGER,right AS LIST OF INTEGER) AS DOUBLE FAILS VectorDimensionError,ZeroVectorError
FUNCTION CosineSimilarity(left AS LIST OF BYTE,right AS LIST OF BYTE) AS DOUBLE FAILS VectorDimensionError,ZeroVectorError
FUNCTION CosineSimilarity(left AS LIST OF UINT32,right AS LIST OF UINT32) AS DOUBLE FAILS VectorDimensionError,ZeroVectorError
FUNCTION CosineSimilarity(left AS LIST OF UINT64,right AS LIST OF UINT64) AS DOUBLE FAILS VectorDimensionError,ZeroVectorError
FUNCTION CosineSimilarity(left AS ARRAY OF DOUBLE,right AS ARRAY OF DOUBLE) AS DOUBLE FAILS VectorDimensionError,ZeroVectorError,VectorRankError
FUNCTION CosineSimilarity(left AS ARRAY OF INTEGER,right AS ARRAY OF INTEGER) AS DOUBLE FAILS VectorDimensionError,ZeroVectorError,VectorRankError
FUNCTION CosineSimilarity(left AS ARRAY OF BYTE,right AS ARRAY OF BYTE) AS DOUBLE FAILS VectorDimensionError,ZeroVectorError,VectorRankError
FUNCTION CosineSimilarity(left AS ARRAY OF UINT32,right AS ARRAY OF UINT32) AS DOUBLE FAILS VectorDimensionError,ZeroVectorError,VectorRankError
FUNCTION CosineSimilarity(left AS ARRAY OF UINT64,right AS ARRAY OF UINT64) AS DOUBLE FAILS VectorDimensionError,ZeroVectorError,VectorRankError

Count

FUNCTION Count[T](c AS Counter[T],key AS T) AS INTEGER FAILS LIKE ValidateKey(AS T)

CountOf

FUNCTION CountOf[T](items AS LIST OF T, value AS T) AS INTEGER

CountWhere

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

CreateLogger

FUNCTION CreateLogger(config AS LogConfig) AS Logger FAILS LoggingError
FUNCTION CreateLogger(path AS STRING) AS Logger FAILS LoggingError
FUNCTION CreateLogger() AS Logger FAILS LoggingError

CreateLogSink

FUNCTION CreateLogSink[T](BYVAL context AS T,handler AS CALLABLE(T,LogRecord) FAILS (Error)) AS LogSink
FUNCTION CreateLogSink[T](BYVAL context AS T,handler AS CALLABLE(BYREF T,LogRecord) FAILS (Error)) AS LogSink
FUNCTION CreateLogSink[T](BYVAL context AS T,handler AS CALLABLE(T,LogRecord) FAILS (Error),finish AS CALLABLE(T) FAILS (Error)) AS LogSink
FUNCTION CreateLogSink[T](BYVAL context AS T,handler AS CALLABLE(BYREF T,LogRecord) FAILS (Error),finish AS CALLABLE(BYREF T) FAILS (Error)) AS LogSink
FUNCTION CreateLogSink(handler AS CALLABLE(LogRecord) FAILS (Error)) AS LogSink

CreatePathMask

FUNCTION CreatePathMask(path AS CanvasPath,width AS INTEGER,height AS INTEGER,rule AS FillRule=FillRule.NonZero,aa AS Antialiasing=Antialiasing.Standard,maxPixels AS INTEGER=16777216) AS Canvas FAILS CanvasError,IndexError,NumericError

CreateTextLayout

FUNCTION CreateTextLayout(fonts AS FontSet,text AS STRING,options AS TextLayoutOptions) AS TextLayout FAILS CanvasError,IndexError,NumericError
FUNCTION CreateTextLayout(font AS Font,text AS STRING,options AS TextLayoutOptions) AS TextLayout FAILS CanvasError,IndexError,NumericError

CropCanvas

FUNCTION CropCanvas(canvas AS Canvas,region AS PixelRect) AS Canvas FAILS CanvasError,IndexError,NumericError

CubicTo

SUB CubicTo(BYREF path AS CanvasPath,firstX AS DOUBLE,firstY AS DOUBLE,secondX AS DOUBLE,secondY AS DOUBLE,x AS DOUBLE,y AS DOUBLE) FAILS CanvasError

CUINT32

FUNCTION CUINT32(value AS INTEGER) AS UINT32 FAILS NumericError
FUNCTION CUINT32(value AS UINT64) AS UINT32 FAILS NumericError

CUINT64

FUNCTION CUINT64(value AS INTEGER) AS UINT64 FAILS NumericError

Find your way around BASIL

Type to search the manual.