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

DateFromEpochDays

FUNCTION DateFromEpochDays(days AS INTEGER) AS Date FAILS DateTimeError

DatePart

FUNCTION DatePart(value AS LocalDateTime) AS Date

DayOfMonth

FUNCTION DayOfMonth(value AS Date) AS INTEGER

DayOfYear

FUNCTION DayOfYear(value AS Date) AS INTEGER FAILS DateTimeError

DaysBetween

FUNCTION DaysBetween(start AS Date,finish AS Date) AS INTEGER

DaysInMonth

FUNCTION DaysInMonth(year AS INTEGER,month AS INTEGER) AS INTEGER FAILS DateTimeError
FUNCTION DaysInMonth(year AS INTEGER,month AS Month) AS INTEGER FAILS DateTimeError

DaysInYear

FUNCTION DaysInYear(year AS INTEGER) AS INTEGER

DeadlineAfter

FUNCTION DeadlineAfter(clock AS Clock,timeout AS Duration) AS Deadline FAILS DateTimeError

DecodeAnimation

FUNCTION DecodeAnimation(bytes AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxFrames AS INTEGER=1000,maxDecodedBytes AS INTEGER=268435456,maxEncodedBytes AS INTEGER=67108864) AS Animation FAILS CanvasError,IndexError,NumericError,StringError

DecodeAPNG

FUNCTION DecodeAPNG(bytes AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxFrames AS INTEGER=1000,maxDecodedBytes AS INTEGER=268435456,maxEncodedBytes AS INTEGER=67108864) AS Animation FAILS CanvasError,IndexError,NumericError,StringError

DecodeBMP

FUNCTION DecodeBMP(data AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxEncodedBytes AS INTEGER=67108864) AS Canvas FAILS CanvasError,IndexError,NumericError

DecodeGIF

FUNCTION DecodeGIF(bytes AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxFrames AS INTEGER=1000,maxDecodedBytes AS INTEGER=268435456,maxEncodedBytes AS INTEGER=67108864) AS Animation FAILS CanvasError,IndexError,NumericError,StringError

DecodeImage

FUNCTION DecodeImage(bytes AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxEncodedBytes AS INTEGER=67108864) AS Canvas FAILS CanvasError,IndexError,NumericError,StringError

DecodeJPEG

FUNCTION DecodeJPEG(bytes AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxEncodedBytes AS INTEGER=67108864,maxWorkingBytes AS INTEGER=268435456) AS Canvas FAILS CanvasError,IndexError,NumericError

DecodeJSON

FUNCTION DecodeJSON[T](text AS STRING,codec AS JsonCodec) AS T FAILS JsonError,LIKE codec, LIKE __JsonDecodeErrors(AS T)
FUNCTION DecodeJSON[T](text AS STRING) AS T FAILS JsonError,LIKE __JsonDecodeErrors(AS T)
FUNCTION DecodeJSON[T](bytes AS LIST OF BYTE,codec AS JsonCodec) AS T FAILS JsonError,LIKE codec, LIKE __JsonDecodeErrors(AS T)
FUNCTION DecodeJSON[T](bytes AS LIST OF BYTE) AS T FAILS JsonError,LIKE __JsonDecodeErrors(AS T)

DecodePNG

FUNCTION DecodePNG(data AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxEncodedBytes AS INTEGER=67108864) AS Canvas FAILS CanvasError,IndexError,NumericError,StringError

DecoderInfo

FUNCTION DecoderInfo(decoder AS TextDecoder) AS TextConversionInfo

DecodeText

FUNCTION DecodeText(bytes AS LIST OF BYTE,encoding AS TextEncoding,errors AS TextErrorPolicy=TextErrorPolicy.Strict,bom AS TextDecodeBom=TextDecodeBom.Preserve,maxOutputBytes AS INTEGER=67108864) AS STRING FAILS TextEncodingError,IndexError,NumericError,StringError

DecodeTextChunk

FUNCTION DecodeTextChunk(BYREF decoder AS TextDecoder,bytes AS LIST OF BYTE,final AS BOOLEAN=FALSE) AS STRING FAILS TextEncodingError,IndexError,NumericError,StringError

DecodeTextWithInfo

FUNCTION DecodeTextWithInfo(bytes AS LIST OF BYTE,encoding AS TextEncoding,errors AS TextErrorPolicy=TextErrorPolicy.Strict,bom AS TextDecodeBom=TextDecodeBom.Preserve,maxOutputBytes AS INTEGER=67108864) AS DecodedText FAILS TextEncodingError,IndexError,NumericError,StringError

DecodeURLComponent

FUNCTION DecodeURLComponent(text AS STRING,form AS BOOLEAN=FALSE) AS STRING FAILS HTTPError,StringError

DecodeUtf8

FUNCTION DecodeUtf8(bytes AS LIST OF INTEGER) AS STRING FAILS StringError
FUNCTION DecodeUtf8(bytes AS LIST OF BYTE) AS STRING FAILS StringError

DecodeVP8

FUNCTION DecodeVP8(bytes AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxWorkingBytes AS INTEGER=268435456) AS Canvas FAILS CanvasError,IndexError,NumericError

DecodeVP8L

FUNCTION DecodeVP8L(bytes AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxWorkingBytes AS INTEGER=268435456) AS Canvas FAILS CanvasError,IndexError,NumericError

DecodeWebP

FUNCTION DecodeWebP(bytes AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxEncodedBytes AS INTEGER=67108864,maxWorkingBytes AS INTEGER=268435456) AS Canvas FAILS CanvasError,IndexError,NumericError,StringError

DecodeWebPAnimation

FUNCTION DecodeWebPAnimation(bytes AS LIST OF BYTE,maxPixels AS INTEGER=16777216,maxFrames AS INTEGER=1000,maxDecodedBytes AS INTEGER=268435456,maxEncodedBytes AS INTEGER=67108864) AS Animation FAILS CanvasError,IndexError,NumericError,StringError

DefaultLogConfig

FUNCTION DefaultLogConfig() AS LogConfig

DefaultLogger

FUNCTION DefaultLogger() AS LoggerHandle

DEGREES

FUNCTION DEGREES(radians AS DOUBLE) AS DOUBLE

Dequeue

FUNCTION Dequeue[T](BYREF q AS Queue[T]) AS T FAILS EmptyCollection

DialTCP

FUNCTION DialTCP(host AS STRING,port AS INTEGER) AS TCPConnection FAILS IoError
FUNCTION DialTCP(host AS STRING,port AS INTEGER,timeout AS Duration) AS TCPConnection FAILS IoError
FUNCTION DialTCP(address AS IPAddress,port AS INTEGER) AS TCPConnection FAILS IoError
FUNCTION DialTCP(address AS IPAddress,port AS INTEGER,timeout AS Duration) AS TCPConnection FAILS IoError

DialTLS

FUNCTION DialTLS(host AS STRING,port AS INTEGER) AS TCPConnection FAILS IoError,TLSError
FUNCTION DialTLS(host AS STRING,port AS INTEGER,options AS TLSClientOptions) AS TCPConnection FAILS IoError,TLSError
FUNCTION DialTLS(host AS STRING,port AS INTEGER,options AS TLSClientOptions,timeout AS Duration) AS TCPConnection FAILS IoError,TLSError

Difference

FUNCTION Difference[K](left AS SET OF K, right AS SET OF K) AS SET OF K

Digest

FUNCTION Digest(bytes AS LIST OF BYTE) AS LIST OF BYTE

DiscoverFonts

FUNCTION DiscoverFonts(directories AS LIST OF STRING,maxFiles AS INTEGER=10000,maxFontBytes AS INTEGER=33554432) AS FontCatalog FAILS CanvasError,IndexError,NumericError,StringError

DiscoverSystemFonts

FUNCTION DiscoverSystemFonts(maxFiles AS INTEGER=10000) AS FontCatalog FAILS CanvasError,IndexError,NumericError,StringError

Display

FUNCTION Display[T](value AS T) AS STRING
FUNCTION Display(value AS STRING) AS STRING
FUNCTION Display(value AS INTEGER) AS STRING
FUNCTION Display(value AS DOUBLE) AS STRING
FUNCTION Display(value AS BOOLEAN) AS STRING
FUNCTION Display(value AS BYTE) AS STRING
FUNCTION Display(value AS UINT32) AS STRING
FUNCTION Display(value AS UINT64) AS STRING
FUNCTION Display(value AS UUID) AS STRING

Distance

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

DivideDuration

FUNCTION DivideDuration(value AS Duration,divisor AS INTEGER,rounding AS RoundingMode=RoundingMode.RejectLoss) AS Duration FAILS DateTimeError

Dot

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

DoubleBits

FUNCTION DoubleBits(value AS DOUBLE) AS INTEGER

DoubleFromBits

FUNCTION DoubleFromBits(bits AS INTEGER) AS DOUBLE

DrawAnimationFrame

SUB DrawAnimationFrame(BYREF canvas AS Canvas,animation AS Animation,index AS INTEGER,x AS INTEGER=0,y AS INTEGER=0,opacity AS DOUBLE=1.0,mode AS BlendMode=BlendMode.SourceOver,space AS BlendSpace=BlendSpace.EncodedSRGB) FAILS CanvasError,IndexError,NumericError

DrawBitmapText

SUB DrawBitmapText(BYREF canvas AS Canvas,text AS STRING,x AS INTEGER,y AS INTEGER,color AS Color,scale AS INTEGER=1,strictGlyphs AS BOOLEAN=FALSE) FAILS CanvasError,IndexError,NumericError

DrawCircle

SUB DrawCircle(BYREF canvas AS Canvas,cx AS DOUBLE,cy AS DOUBLE,radius AS DOUBLE,stroke AS Stroke) FAILS CanvasError,IndexError,NumericError

DrawDashedPath

SUB DrawDashedPath(BYREF canvas AS Canvas,path AS CanvasPath,stroke AS Stroke,dashes AS LIST OF DOUBLE,dashOffset AS DOUBLE=0.0,mode AS BlendMode=BlendMode.SourceOver,space AS BlendSpace=BlendSpace.EncodedSRGB) FAILS CanvasError,IndexError,NumericError

DrawDashedPolyline

SUB DrawDashedPolyline(BYREF canvas AS Canvas,points AS LIST OF Point,stroke AS Stroke,dashes AS LIST OF DOUBLE,dashOffset AS DOUBLE=0.0,closed AS BOOLEAN=FALSE) FAILS CanvasError,IndexError,NumericError

DrawEllipse

SUB DrawEllipse(BYREF canvas AS Canvas,cx AS DOUBLE,cy AS DOUBLE,rx AS DOUBLE,ry AS DOUBLE,stroke AS Stroke) FAILS CanvasError,IndexError,NumericError

DrawImage

SUB DrawImage(BYREF destination AS Canvas,source AS Canvas,x AS INTEGER,y AS INTEGER,opacity AS DOUBLE=1.0,mode AS BlendMode=BlendMode.SourceOver,space AS BlendSpace=BlendSpace.EncodedSRGB) FAILS CanvasError,IndexError,NumericError

DrawLine

SUB DrawLine(BYREF canvas AS Canvas,x0 AS DOUBLE,y0 AS DOUBLE,x1 AS DOUBLE,y1 AS DOUBLE,stroke AS Stroke) FAILS CanvasError,IndexError,NumericError

DrawPath

SUB DrawPath(BYREF canvas AS Canvas,path AS CanvasPath,stroke AS Stroke,mode AS BlendMode=BlendMode.SourceOver,space AS BlendSpace=BlendSpace.EncodedSRGB) FAILS CanvasError,IndexError,NumericError

DrawPolyline

SUB DrawPolyline(BYREF canvas AS Canvas,points AS LIST OF Point,stroke AS Stroke,closed AS BOOLEAN=FALSE) FAILS CanvasError,IndexError,NumericError

DrawRect

SUB DrawRect(BYREF canvas AS Canvas,x AS DOUBLE,y AS DOUBLE,width AS DOUBLE,height AS DOUBLE,stroke AS Stroke) FAILS CanvasError,IndexError,NumericError

DrawRoundedRect

SUB DrawRoundedRect(BYREF canvas AS Canvas,x AS DOUBLE,y AS DOUBLE,width AS DOUBLE,height AS DOUBLE,radius AS DOUBLE,stroke AS Stroke) FAILS CanvasError,IndexError,NumericError

DrawText

SUB DrawText(BYREF canvas AS Canvas,font AS Font,text AS STRING,x AS DOUBLE,y AS DOUBLE,style AS TextStyle) FAILS CanvasError,IndexError,NumericError

DrawTextLayout

SUB DrawTextLayout(BYREF canvas AS Canvas,layout AS TextLayout,x AS DOUBLE,y AS DOUBLE,color AS Color,aa AS Antialiasing=Antialiasing.Standard,mode AS BlendMode=BlendMode.SourceOver,space AS BlendSpace=BlendSpace.EncodedSRGB) FAILS CanvasError,IndexError,NumericError

DurationMicroseconds

FUNCTION DurationMicroseconds(value AS Duration,rounding AS RoundingMode=RoundingMode.RejectLoss) AS INTEGER FAILS DateTimeError

DurationMilliseconds

FUNCTION DurationMilliseconds(value AS Duration,rounding AS RoundingMode=RoundingMode.RejectLoss) AS INTEGER FAILS DateTimeError

DurationNanoseconds

FUNCTION DurationNanoseconds(value AS Duration) AS INTEGER FAILS DateTimeError

DurationSeconds

FUNCTION DurationSeconds(value AS Duration) AS INTEGER

Find your way around BASIL

Type to search the manual.