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

SameFileVersion

FUNCTION SameFileVersion(left AS FileInfo,right AS FileInfo) AS BOOLEAN

SameInstant

FUNCTION SameInstant(left AS OffsetDateTime,right AS OffsetDateTime) AS BOOLEAN FAILS DateTimeError
FUNCTION SameInstant(left AS ZonedDateTime,right AS ZonedDateTime) AS BOOLEAN

SameLocalDateTime

FUNCTION SameLocalDateTime(left AS LocalDateTime,right AS LocalDateTime) AS BOOLEAN

SameZoneRules

FUNCTION SameZoneRules(left AS TimeZone,right AS TimeZone) AS BOOLEAN

SamplePixel

FUNCTION SamplePixel(canvas AS Canvas,x AS DOUBLE,y AS DOUBLE,sampling AS Sampling=Sampling.Bilinear,space AS BlendSpace=BlendSpace.EncodedSRGB) AS Color FAILS CanvasError,IndexError,NumericError

SaveAnimation

SUB SaveAnimation(animation AS Animation,path AS STRING,format AS ImageFormat=ImageFormat.Auto,maxEncodedBytes AS INTEGER=67108864) FAILS CanvasError,IndexError,NumericError,StringError,IoError

SaveImage

SUB SaveImage(canvas AS Canvas,path AS STRING,format AS ImageFormat=ImageFormat.Auto) FAILS CanvasError,IndexError,NumericError,StringError,IoError

Scaled

FUNCTION Scaled(values AS LIST OF DOUBLE,factor AS DOUBLE) AS LIST OF DOUBLE
FUNCTION Scaled(values AS LIST OF INTEGER,factor AS INTEGER) AS LIST OF INTEGER FAILS NumericError
FUNCTION Scaled(values AS LIST OF BYTE,factor AS BYTE) AS LIST OF BYTE FAILS NumericError
FUNCTION Scaled(values AS LIST OF UINT32,factor AS UINT32) AS LIST OF UINT32 FAILS NumericError
FUNCTION Scaled(values AS LIST OF UINT64,factor AS UINT64) AS LIST OF UINT64 FAILS NumericError
FUNCTION Scaled(values AS ARRAY OF DOUBLE,factor AS DOUBLE) AS LIST OF DOUBLE FAILS VectorRankError
FUNCTION Scaled(values AS ARRAY OF INTEGER,factor AS INTEGER) AS LIST OF INTEGER FAILS VectorRankError,NumericError
FUNCTION Scaled(values AS ARRAY OF BYTE,factor AS BYTE) AS LIST OF BYTE FAILS VectorRankError,NumericError
FUNCTION Scaled(values AS ARRAY OF UINT32,factor AS UINT32) AS LIST OF UINT32 FAILS VectorRankError,NumericError
FUNCTION Scaled(values AS ARRAY OF UINT64,factor AS UINT64) AS LIST OF UINT64 FAILS VectorRankError,NumericError

ScalingTransform

FUNCTION ScalingTransform(x AS DOUBLE,y AS DOUBLE) AS AffineTransform FAILS CanvasError

Second

FUNCTION Second(value AS TimeOfDay) AS INTEGER

Seconds

FUNCTION Seconds(value AS INTEGER) AS Duration

SecureRandomBytes

FUNCTION SecureRandomBytes(count AS INTEGER) AS LIST OF BYTE FAILS IoError,IndexError

Seek

FUNCTION Seek(BYREF reader AS ByteReader,position AS INTEGER) AS INTEGER FAILS IndexError

SeekFile

FUNCTION SeekFile(file AS File,position AS INTEGER) AS INTEGER FAILS IoError

Send

FUNCTION Send[T](port AS SENDER OF T, message AS T) AS INTEGER FAILS ChannelClosed

SendHTTPRequest

FUNCTION SendHTTPRequest(connection AS TCPConnection,BYREF exchange AS HTTPExchange,method AS STRING,url AS HTTPURL,headers AS LIST OF HTTPHeader,body AS LIST OF BYTE) AS INTEGER FAILS IoError,HTTPError,StringError

SerializationSchema

FUNCTION SerializationSchema[T](witness AS OPTIONAL OF T) AS SerializationSchema

SerializationTypeSchema

FUNCTION SerializationTypeSchema[T](witness AS OPTIONAL OF T) AS TypeGraph

ServeDirectory

SUB ServeDirectory(connection AS TCPConnection,root AS STRING,options AS HTTPOptions)
SUB ServeDirectory(connection AS TCPConnection,root AS STRING)
SUB ServeDirectory(connection AS TCPConnection,root AS STRING,tls AS TLSServerOptions,options AS HTTPOptions)
SUB ServeDirectory(connection AS TCPConnection,root AS STRING,tls AS TLSServerOptions)

ServeHTTP

SUB ServeHTTP(connection AS TCPConnection,router AS HTTPRouter,options AS HTTPOptions)
SUB ServeHTTP(connection AS TCPConnection,router AS HTTPRouter)
SUB ServeHTTP(listener AS TCPListener,router AS HTTPRouter,options AS HTTPOptions) FAILS IoError
SUB ServeHTTP(listener AS TCPListener,router AS HTTPRouter) FAILS IoError

ServeHTTPChecked

FUNCTION ServeHTTPChecked(connection AS TCPConnection,router AS HTTPRouter,options AS HTTPOptions) AS INTEGER FAILS IoError,HTTPError,IndexError,StringError,JsonError,LIKE router

ServeHTTPS

SUB ServeHTTPS(connection AS TCPConnection,router AS HTTPRouter,tls AS TLSServerOptions,options AS HTTPOptions)
SUB ServeHTTPS(connection AS TCPConnection,router AS HTTPRouter,tls AS TLSServerOptions)
SUB ServeHTTPS(listener AS TCPListener,router AS HTTPRouter,tls AS TLSServerOptions,options AS HTTPOptions) FAILS IoError
SUB ServeHTTPS(listener AS TCPListener,router AS HTTPRouter,tls AS TLSServerOptions) FAILS IoError

SetDefault

FUNCTION SetDefault[K,V](BYREF table AS DICT OF K TO V, key AS K, fallback AS V) AS V FAILS LIKE ValidateKey(AS K) WHERE V IS COPYABLE
FUNCTION SetDefault[K,V](BYREF table AS DICT OF K TO OPTIONAL OF V, key AS K) AS OPTIONAL OF V FAILS LIKE ValidateKey(AS K) WHERE V IS COPYABLE
FUNCTION SetDefault[K,V](BYREF table AS DICT OF K TO V,key AS K,BYVAL fallback AS V) AS BORROW V FROM table FAILS LIKE ValidateKey(AS K) WHERE V IS RESOURCE
FUNCTION SetDefault[K,V](BYREF table AS DICT OF K TO OPTIONAL OF V,key AS K) AS BORROW OPTIONAL OF V FROM table FAILS LIKE ValidateKey(AS K) WHERE V IS RESOURCE

SetDefaultLogger

SUB SetDefaultLogger(BYVAL logger AS Logger) FAILS LoggingError
SUB SetDefaultLogger(logger AS LoggerHandle) FAILS LoggingError

SetDifference

FUNCTION SetDifference[T](left AS SortedSet[T],right AS SortedSet[T]) AS SortedSet[T] FAILS LIKE __ValueOrderCheck(AS T),LIKE ValidateKey(AS T)

SetFilePermissions

FUNCTION SetFilePermissions(path AS STRING,mode AS INTEGER) AS INTEGER FAILS IoError

SetIntersection

FUNCTION SetIntersection[T](left AS SortedSet[T],right AS SortedSet[T]) AS SortedSet[T] FAILS LIKE __ValueOrderCheck(AS T),LIKE ValidateKey(AS T)

SetLogConfig

SUB SetLogConfig(logger AS Logger,config AS LogConfig) FAILS LoggingError
SUB SetLogConfig(logger AS LoggerHandle,config AS LogConfig) FAILS LoggingError
SUB SetLogConfig(config AS LogConfig) FAILS LoggingError

SetLogFormat

SUB SetLogFormat(logger AS Logger,pattern AS STRING) FAILS LoggingError
SUB SetLogFormat(logger AS LoggerHandle,pattern AS STRING) FAILS LoggingError
SUB SetLogFormat(pattern AS STRING) FAILS LoggingError

SetLogLevel

SUB SetLogLevel(logger AS Logger,level AS LogLevel) FAILS LoggingError
SUB SetLogLevel(logger AS LoggerHandle,level AS LogLevel) FAILS LoggingError
SUB SetLogLevel(level AS LogLevel) FAILS LoggingError

SetPixel

SUB SetPixel(BYREF canvas AS Canvas,x AS INTEGER,y AS INTEGER,color AS Color) FAILS CanvasError,IndexError,NumericError

SetSymmetricDifference

FUNCTION SetSymmetricDifference[T](left AS SortedSet[T],right AS SortedSet[T]) AS SortedSet[T] FAILS LIKE __ValueOrderCheck(AS T),LIKE ValidateKey(AS T)

SetUnion

FUNCTION SetUnion[T](left AS SortedSet[T],right AS SortedSet[T]) AS SortedSet[T] FAILS LIKE __ValueOrderCheck(AS T),LIKE ValidateKey(AS T)

SetURLQueryParameter

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

SetValue

FUNCTION SetValue[K,V](BYREF d AS SortedDictionary[K,V],key AS K,BYVAL value AS V) AS BOOLEAN FAILS IndexError,LIKE __ValueOrderCheck(AS K),LIKE ValidateKey(AS K)

SGN

FUNCTION SGN(value AS INTEGER) AS INTEGER
FUNCTION SGN(value AS DOUBLE) AS INTEGER FAILS MathError

SharpenCanvas

FUNCTION SharpenCanvas(canvas AS Canvas) AS Canvas FAILS CanvasError,IndexError,NumericError

ShiftLeft

FUNCTION ShiftLeft(value AS UINT64, count AS INTEGER) AS UINT64

ShiftRight

FUNCTION ShiftRight(value AS UINT64, count AS INTEGER) AS UINT64

ShiftTime

FUNCTION ShiftTime(value AS TimeOfDay,nanoseconds AS INTEGER) AS TimeShift
FUNCTION ShiftTime(value AS TimeOfDay,amount AS Duration) AS TimeShift FAILS DateTimeError

ShowTerminalCursor

FUNCTION ShowTerminalCursor(terminal AS Terminal,visible AS BOOLEAN) AS INTEGER FAILS IoError

SIGN

FUNCTION SIGN(value AS INTEGER) AS INTEGER
FUNCTION SIGN(value AS DOUBLE) AS INTEGER FAILS MathError

SIN

FUNCTION SIN(value AS DOUBLE) AS DOUBLE

SINH

FUNCTION SINH(value AS DOUBLE) AS DOUBLE

Skip

FUNCTION Skip(BYREF reader AS ByteReader,count AS INTEGER) AS INTEGER FAILS IndexError

Slice

FUNCTION Slice[T](items AS LIST OF T, start AS INTEGER, finish AS INTEGER) AS LIST OF T FAILS IndexError

Snapshot

FUNCTION Snapshot[T](q AS Deque[T]) AS LIST OF T WHERE T IS COPYABLE
FUNCTION Snapshot[T](q AS Queue[T]) AS LIST OF T WHERE T IS COPYABLE
FUNCTION Snapshot[T](q AS BoundedDeque[T]) AS LIST OF T WHERE T IS COPYABLE
FUNCTION Snapshot[T](s AS SortedSet[T]) AS LIST OF T

Sort

FUNCTION Sort[T,R](BYREF items AS LIST OF T,Compare AS CALLABLE(T,T) AS R) AS INTEGER FAILS LIKE __SortResult(AS R)
FUNCTION Sort[T](BYREF items AS LIST OF T) AS INTEGER FAILS LIKE __ValueOrderCheck(AS T)

Sorted

FUNCTION Sorted[T,R](items AS LIST OF T, Compare AS CALLABLE(T,T) AS R) AS LIST OF T FAILS LIKE __SortResult(AS R)
FUNCTION Sorted[T](items AS LIST OF T) AS LIST OF T FAILS LIKE __ValueOrderCheck(AS T)
FUNCTION Sorted[R](text AS STRING, Compare AS CALLABLE(STRING, STRING) AS R) AS STRING FAILS LIKE __SortResult(AS R)
FUNCTION Sorted(text AS STRING) AS STRING

SPACE

FUNCTION SPACE(count AS INTEGER) AS STRING FAILS StringError

SPLIT

FUNCTION SPLIT(text AS STRING, separator AS STRING="") AS LIST OF STRING FAILS StringError

SqlBlob

FUNCTION SqlBlob(value AS LIST OF BYTE) AS SqlValue

SqlBoolean

FUNCTION SqlBoolean(value AS BOOLEAN) AS SqlValue

SqlGetBlob

FUNCTION SqlGetBlob(value AS SqlValue) AS LIST OF BYTE FAILS SqliteError

SqlGetBoolean

FUNCTION SqlGetBoolean(value AS SqlValue) AS BOOLEAN FAILS SqliteError

SqlGetInteger

FUNCTION SqlGetInteger(value AS SqlValue) AS INTEGER FAILS SqliteError

SqlGetReal

FUNCTION SqlGetReal(value AS SqlValue) AS DOUBLE FAILS SqliteError

SqlGetText

FUNCTION SqlGetText(value AS SqlValue) AS STRING FAILS SqliteError

SqlInteger

FUNCTION SqlInteger(value AS INTEGER) AS SqlValue
FUNCTION SqlInteger(value AS UINT64) AS SqlValue FAILS SqliteError

SqlNull

FUNCTION SqlNull() AS SqlValue

SqlReal

FUNCTION SqlReal(value AS DOUBLE) AS SqlValue

SqlText

FUNCTION SqlText(value AS STRING) AS SqlValue

SQR

FUNCTION SQR(value AS DOUBLE) AS DOUBLE

SQRT

FUNCTION SQRT(value AS DOUBLE) AS DOUBLE

StartHTTPRequest

FUNCTION StartHTTPRequest(connection AS TCPConnection,BYREF exchange AS HTTPExchange,method AS STRING,url AS HTTPURL,headers AS LIST OF HTTPHeader,length AS INTEGER=-1) AS INTEGER FAILS IoError,HTTPError,StringError

StartHTTPResponse

FUNCTION StartHTTPResponse(connection AS TCPConnection,BYREF exchange AS HTTPExchange,status AS INTEGER,headers AS LIST OF HTTPHeader) AS INTEGER FAILS IoError,HTTPError,StringError

StartOfDay

FUNCTION StartOfDay(value AS Date,zone AS TimeZone,options AS LocalResolveOptions) AS ZonedDateTime FAILS DateTimeError
FUNCTION StartOfDay(value AS Date,zone AS TimeZone) AS ZonedDateTime FAILS DateTimeError

StartOfMonth

FUNCTION StartOfMonth(value AS Date) AS Date FAILS DateTimeError

StartOfWeek

FUNCTION StartOfWeek(value AS Date,firstDay AS INTEGER=1) AS Date FAILS DateTimeError
FUNCTION StartOfWeek(value AS Date,firstDay AS Weekday) AS Date FAILS DateTimeError

StartOfYear

FUNCTION StartOfYear(value AS Date) AS Date FAILS DateTimeError

StartProcess

FUNCTION StartProcess(executable AS STRING,arguments AS LIST OF STRING,directory AS STRING=".",interactive AS BOOLEAN=FALSE) AS Process FAILS IoError

STARTSWITH

FUNCTION STARTSWITH(text AS STRING, prefix AS STRING) AS BOOLEAN

StartTLS

FUNCTION StartTLS(connection AS TCPConnection,options AS TLSClientOptions) AS INTEGER FAILS IoError,TLSError
FUNCTION StartTLS(connection AS TCPConnection,options AS TLSClientOptions,timeout AS Duration) AS INTEGER FAILS IoError,TLSError
FUNCTION StartTLS(connection AS TCPConnection,options AS TLSServerOptions) AS INTEGER FAILS IoError,TLSError
FUNCTION StartTLS(connection AS TCPConnection,options AS TLSServerOptions,timeout AS Duration) AS INTEGER FAILS IoError,TLSError

Stderr

FUNCTION Stderr() AS File FAILS IoError

Stdin

FUNCTION Stdin() AS File FAILS IoError

Stdout

FUNCTION Stdout() AS File FAILS IoError

STR

FUNCTION STR(value AS UINT64) AS STRING
FUNCTION STR(value AS BYTE) AS STRING
FUNCTION STR(value AS UINT32) AS STRING
FUNCTION STR(value AS INTEGER) AS STRING
FUNCTION STR(value AS DOUBLE) AS STRING

StringBuilder

FUNCTION StringBuilder(Capacity AS INTEGER=0) AS StringBuilder FAILS IndexError
FUNCTION StringBuilder(text AS STRING) AS StringBuilder

StringifyJSON

FUNCTION StringifyJSON(value AS JsonValue,codec AS JsonCodec) AS STRING FAILS JsonError
FUNCTION StringifyJSON(value AS JsonValue) AS STRING FAILS JsonError

SubtractDuration

FUNCTION SubtractDuration(left AS Duration,right AS Duration) AS Duration FAILS DateTimeError

SuspendTerminal

FUNCTION SuspendTerminal(terminal AS Terminal) AS INTEGER FAILS IoError

SwapAt

FUNCTION SwapAt[T](BYREF items AS LIST OF T,first AS INTEGER,second AS INTEGER) AS INTEGER FAILS IndexError

SymmetricDifference

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

Find your way around BASIL

Type to search the manual.