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

FillCircle

SUB FillCircle(BYREF canvas AS Canvas,cx AS DOUBLE,cy AS DOUBLE,radius AS DOUBLE,color AS Color,aa AS Antialiasing=Antialiasing.Standard) FAILS CanvasError,IndexError,NumericError

FillEllipse

SUB FillEllipse(BYREF canvas AS Canvas,cx AS DOUBLE,cy AS DOUBLE,rx AS DOUBLE,ry AS DOUBLE,color AS Color,aa AS Antialiasing=Antialiasing.Standard) FAILS CanvasError,IndexError,NumericError

FillPath

SUB FillPath(BYREF canvas AS Canvas,path AS CanvasPath,color AS Color,rule AS FillRule=FillRule.NonZero,aa AS Antialiasing=Antialiasing.Standard,mode AS BlendMode=BlendMode.SourceOver,space AS BlendSpace=BlendSpace.EncodedSRGB) FAILS CanvasError,IndexError,NumericError

FillPolygon

SUB FillPolygon(BYREF canvas AS Canvas,points AS LIST OF Point,color AS Color,aa AS Antialiasing=Antialiasing.Standard) FAILS CanvasError,IndexError,NumericError

FillRect

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

FillRoundedRect

SUB FillRoundedRect(BYREF canvas AS Canvas,x AS DOUBLE,y AS DOUBLE,width AS DOUBLE,height AS DOUBLE,radius AS DOUBLE,color AS Color,aa AS Antialiasing=Antialiasing.Standard) FAILS CanvasError,IndexError,NumericError

FillSecureRandom

FUNCTION FillSecureRandom(BYREF bytes AS LIST OF BYTE) AS INTEGER FAILS IoError

Filter

FUNCTION Filter[T](items AS LIST OF T,Predicate AS CALLABLE(T) AS BOOLEAN) AS LIST OF T WHERE T IS COPYABLE
FUNCTION Filter[T](items AS SET OF T,Predicate AS CALLABLE(T) AS BOOLEAN) AS SET OF T WHERE T IS COPYABLE
FUNCTION Filter[K,V](items AS DICT OF K TO V,Predicate AS CALLABLE(K,V) AS BOOLEAN) AS DICT OF K TO V FAILS LIKE ValidateKey(AS K) WHERE V IS COPYABLE

Find

FUNCTION Find(value AS JsonValue,key AS STRING) AS OPTIONAL OF JsonValue FAILS JsonError
FUNCTION Find[K,V](table AS DICT OF K TO V, key AS K) AS OPTIONAL OF V FAILS LIKE ValidateKey(AS K) WHERE V IS COPYABLE
FUNCTION Find[K,V](table AS DICT OF K TO V,key AS K) AS BORROW OPTIONAL OF V FROM table FAILS LIKE ValidateKey(AS K) WHERE V IS RESOURCE
FUNCTION Find[K,V](m AS MultiMap[K,V],key AS K) AS OPTIONAL OF LIST OF V FAILS LIKE ValidateKey(AS K) WHERE V IS COPYABLE
FUNCTION Find[K,V](m AS MultiMap[K,V],key AS K) AS BORROW OPTIONAL OF LIST OF V FROM m FAILS LIKE ValidateKey(AS K) WHERE V IS RESOURCE

FindFont

FUNCTION FindFont(catalog AS FontCatalog,family AS STRING,weight AS INTEGER=400,italic AS BOOLEAN=FALSE,allowSubstitution AS BOOLEAN=FALSE) AS FontMatch FAILS CanvasError,IndexError,NumericError,StringError

FindTimeZone

FUNCTION FindTimeZone(value AS ZoneDatabase,id AS STRING) AS TimeZone FAILS DateTimeError

FindWhere

FUNCTION FindWhere[T](items AS LIST OF T,Predicate AS CALLABLE(T) AS BOOLEAN) AS OPTIONAL OF T WHERE T IS COPYABLE

Finish

FUNCTION Finish[T](BYVAL writer AS BufferedWriter[T]) AS T FAILS IoError WHERE T IS RESOURCE

FinishHTTPRequest

FUNCTION FinishHTTPRequest(connection AS TCPConnection,BYREF exchange AS HTTPExchange) AS INTEGER FAILS IoError,HTTPError,StringError
FUNCTION FinishHTTPRequest(connection AS TCPConnection,BYREF exchange AS HTTPExchange,trailers AS LIST OF HTTPHeader) AS INTEGER FAILS IoError,HTTPError,StringError

FinishHTTPResponse

FUNCTION FinishHTTPResponse(connection AS TCPConnection,BYREF exchange AS HTTPExchange,trailers AS LIST OF HTTPHeader) AS INTEGER FAILS IoError,HTTPError,StringError
FUNCTION FinishHTTPResponse(connection AS TCPConnection,BYREF exchange AS HTTPExchange) AS INTEGER FAILS IoError,HTTPError,StringError

FinishTextDecoder

FUNCTION FinishTextDecoder(BYREF decoder AS TextDecoder) AS STRING FAILS TextEncodingError,IndexError,NumericError,StringError

FinishTextEncoder

FUNCTION FinishTextEncoder(BYREF encoder AS TextEncoder) AS LIST OF BYTE FAILS TextEncodingError,IndexError,NumericError,StringError

FinishTLS

FUNCTION FinishTLS(connection AS TCPConnection,timeout AS Duration) AS INTEGER FAILS IoError,TLSError

Finite

FUNCTION Finite(value AS DOUBLE) AS DOUBLE FAILS NonFiniteError

FitCanvas

FUNCTION FitCanvas(source AS Canvas,width AS INTEGER,height AS INTEGER,fit AS ImageFit=ImageFit.Contain,sampling AS Sampling=Sampling.Bilinear,space AS BlendSpace=BlendSpace.EncodedSRGB,maxPixels AS INTEGER=16777216) AS Canvas FAILS CanvasError,IndexError,NumericError

FIX

FUNCTION FIX(value AS DOUBLE) AS DOUBLE

FixedOffsetZone

FUNCTION FixedOffsetZone(offset AS UtcOffset) AS TimeZone FAILS DateTimeError

FlattenCanvas

FUNCTION FlattenCanvas(canvas AS Canvas,background AS Color,space AS BlendSpace=BlendSpace.EncodedSRGB) AS Canvas FAILS CanvasError,IndexError,NumericError

Flip

SUB Flip(BYREF bits AS BitSet,index AS INTEGER) FAILS IndexError

FlipCanvas

FUNCTION FlipCanvas(canvas AS Canvas,horizontal AS BOOLEAN=TRUE,vertical AS BOOLEAN=FALSE) AS Canvas FAILS CanvasError,IndexError,NumericError

FLOOR

FUNCTION FLOOR(value AS DOUBLE) AS DOUBLE

FloorDiv

FUNCTION FloorDiv(value AS INTEGER,divisor AS INTEGER) AS INTEGER FAILS NumericError

FloorToInteger

FUNCTION FloorToInteger(value AS DOUBLE) AS INTEGER FAILS NumericError

Flush

FUNCTION Flush(file AS File) AS INTEGER FAILS IoError
FUNCTION Flush(logger AS LoggerHandle) AS INTEGER FAILS LoggingError
FUNCTION Flush(logger AS Logger) AS INTEGER FAILS LoggingError
FUNCTION Flush[T](BYREF writer AS BufferedWriter[T]) AS INTEGER FAILS IoError WHERE T IS RESOURCE

FMA

FUNCTION FMA(x AS DOUBLE, y AS DOUBLE, z AS DOUBLE) AS DOUBLE

FMOD

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

FontCatalogCount

FUNCTION FontCatalogCount(catalog AS FontCatalog) AS INTEGER

FontCatalogEntry

FUNCTION FontCatalogEntry(catalog AS FontCatalog,index AS INTEGER) AS FontInfo FAILS CanvasError,IndexError

FontDiscoveryWarnings

FUNCTION FontDiscoveryWarnings(catalog AS FontCatalog) AS LIST OF STRING

FontFaceCount

FUNCTION FontFaceCount(bytes AS LIST OF BYTE) AS INTEGER FAILS CanvasError,IndexError

FontHasGlyph

FUNCTION FontHasGlyph(font AS Font,scalar AS INTEGER) AS BOOLEAN FAILS CanvasError,IndexError

FontSetCount

FUNCTION FontSetCount(fonts AS FontSet) AS INTEGER

FontSetHasGlyph

FUNCTION FontSetHasGlyph(fonts AS FontSet,scalar AS INTEGER) AS BOOLEAN FAILS CanvasError,IndexError

FORMAT

FUNCTION FORMAT(template AS STRING, values AS LIST OF STRING) AS STRING FAILS StringError

FormatDate

FUNCTION FormatDate(value AS Date) AS STRING FAILS DateTimeError

FormatDateTimeAmount

FUNCTION FormatDateTimeAmount(value AS DateTimeAmount) AS STRING FAILS DateTimeError

FormatDuration

FUNCTION FormatDuration(value AS Duration) AS STRING FAILS DateTimeError

FormatHttpDate

FUNCTION FormatHttpDate(value AS Instant) AS STRING FAILS DateTimeError

FormatInstant

FUNCTION FormatInstant(value AS Instant) AS STRING FAILS DateTimeError
FUNCTION FormatInstant(value AS Instant,options AS FormatOptions) AS STRING FAILS DateTimeError

FormatIsoWeekDate

FUNCTION FormatIsoWeekDate(value AS IsoWeekDate) AS STRING FAILS DateTimeError

FormatLocalDateTime

FUNCTION FormatLocalDateTime(value AS LocalDateTime) AS STRING FAILS DateTimeError
FUNCTION FormatLocalDateTime(value AS LocalDateTime,options AS FormatOptions) AS STRING FAILS DateTimeError

FormatLogRecord

FUNCTION FormatLogRecord(record AS LogRecord,pattern AS STRING) AS STRING FAILS LoggingError

FormatMetadata

FUNCTION FormatMetadata[T,M](witness AS OPTIONAL OF T,field AS STRING="") AS OPTIONAL OF M
FUNCTION FormatMetadata[M](graph AS TypeGraph,node AS INTEGER,field AS STRING="") AS OPTIONAL OF M FAILS JsonError

FormatMonthDay

FUNCTION FormatMonthDay(value AS MonthDay) AS STRING FAILS DateTimeError

FormatOffset

FUNCTION FormatOffset(value AS UtcOffset) AS STRING FAILS DateTimeError

FormatOffsetDateTime

FUNCTION FormatOffsetDateTime(value AS OffsetDateTime) AS STRING FAILS DateTimeError
FUNCTION FormatOffsetDateTime(value AS OffsetDateTime,options AS FormatOptions) AS STRING FAILS DateTimeError

FormatOffsetTime

FUNCTION FormatOffsetTime(value AS OffsetTime) AS STRING FAILS DateTimeError

FormatPeriod

FUNCTION FormatPeriod(value AS Period) AS STRING FAILS DateTimeError

FormatRfc3339

FUNCTION FormatRfc3339(value AS OffsetDateTime) AS STRING FAILS DateTimeError
FUNCTION FormatRfc3339(value AS Instant) AS STRING FAILS DateTimeError
FUNCTION FormatRfc3339(value AS Instant,options AS FormatOptions) AS STRING FAILS DateTimeError
FUNCTION FormatRfc3339(value AS OffsetDateTime,options AS FormatOptions) AS STRING FAILS DateTimeError

FormatRfc9557

FUNCTION FormatRfc9557(value AS ZonedDateTime) AS STRING FAILS DateTimeError
FUNCTION FormatRfc9557(value AS ZonedDateTime,options AS FormatOptions) AS STRING FAILS DateTimeError

FormatTime

FUNCTION FormatTime(value AS TimeOfDay) AS STRING FAILS DateTimeError
FUNCTION FormatTime(value AS TimeOfDay,options AS FormatOptions) AS STRING FAILS DateTimeError

FormatURL

FUNCTION FormatURL(value AS URL) AS STRING

FormatURLQuery

FUNCTION FormatURLQuery(parameters AS LIST OF URLParameter,form AS BOOLEAN=TRUE) AS STRING FAILS UrlError

FormatUUID

FUNCTION FormatUUID(value AS UUID) AS STRING
FUNCTION FormatUUID(value AS UUID,style AS UuidFormat) AS STRING

FormatWithPattern

FUNCTION FormatWithPattern(value AS Date,pattern AS DateTimePattern) AS STRING FAILS DateTimeError
FUNCTION FormatWithPattern(value AS TimeOfDay,pattern AS DateTimePattern) AS STRING FAILS DateTimeError
FUNCTION FormatWithPattern(value AS LocalDateTime,pattern AS DateTimePattern) AS STRING FAILS DateTimeError
FUNCTION FormatWithPattern(value AS OffsetDateTime,pattern AS DateTimePattern) AS STRING FAILS DateTimeError
FUNCTION FormatWithPattern(value AS Instant,pattern AS DateTimePattern) AS STRING FAILS DateTimeError

FormatYearMonth

FUNCTION FormatYearMonth(value AS YearMonth) AS STRING FAILS DateTimeError

FormatZonedDateTime

FUNCTION FormatZonedDateTime(value AS ZonedDateTime) AS STRING FAILS DateTimeError
FUNCTION FormatZonedDateTime(value AS ZonedDateTime,options AS FormatOptions) AS STRING FAILS DateTimeError

FREXP

FUNCTION FREXP(value AS DOUBLE) AS FloatParts

FromIsoWeekDate

FUNCTION FromIsoWeekDate(value AS IsoWeekDate) AS Date FAILS DateTimeError

FromJSON

FUNCTION FromJSON[T](value AS JsonValue,codec AS JsonCodec) AS T FAILS JsonError,LIKE codec, LIKE __JsonDecodeErrors(AS T)
FUNCTION FromJSON[T](value AS JsonValue) AS T FAILS JsonError,LIKE __JsonDecodeErrors(AS T)

FromValue

FUNCTION FromValue[T](value AS JsonValue) AS T FAILS JsonError,LIKE __JsonDecodeErrors(AS T)

Front

FUNCTION Front[T](q AS Deque[T]) AS T FAILS EmptyCollection WHERE T IS COPYABLE
FUNCTION Front[T](q AS Queue[T]) AS T FAILS EmptyCollection WHERE T IS COPYABLE
FUNCTION Front[T](q AS Deque[T]) AS BORROW T FROM q FAILS EmptyCollection WHERE T IS RESOURCE
FUNCTION Front[T](q AS Queue[T]) AS BORROW T FROM q FAILS EmptyCollection WHERE T IS RESOURCE
FUNCTION Front[T](q AS BoundedDeque[T]) AS T FAILS EmptyCollection WHERE T IS COPYABLE
FUNCTION Front[T](q AS BoundedDeque[T]) AS BORROW T FROM q FAILS EmptyCollection WHERE T IS RESOURCE

Find your way around BASIL

Type to search the manual.