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

WaitForIO

FUNCTION WaitForIO(fds AS LIST OF INTEGER,events AS LIST OF INTEGER,deadline AS INTEGER=0) AS INTEGER FAILS IoError

WaitProcess

FUNCTION WaitProcess(process AS Process) AS INTEGER FAILS IoError

WarpCanvas

FUNCTION WarpCanvas(source AS Canvas,transform AS AffineTransform,width AS INTEGER,height AS INTEGER,sampling AS Sampling=Sampling.Bilinear,space AS BlendSpace=BlendSpace.EncodedSRGB,maxPixels AS INTEGER=16777216) AS Canvas FAILS CanvasError,IndexError,NumericError

WeekdayNumber

FUNCTION WeekdayNumber(value AS Weekday) AS INTEGER

WeekdayOf

FUNCTION WeekdayOf(value AS Date) AS Weekday

WeekOfYear

FUNCTION WeekOfYear(value AS Date,rules AS WeekRules) AS WeekDateParts FAILS DateTimeError

WithOffsetSameInstant

FUNCTION WithOffsetSameInstant(value AS OffsetDateTime,offset AS UtcOffset) AS OffsetDateTime FAILS DateTimeError

WithoutURLCredentials

FUNCTION WithoutURLCredentials(BYVAL value AS URL) AS URL

WithoutURLFragment

FUNCTION WithoutURLFragment(BYVAL value AS URL) AS URL

WithoutURLPort

FUNCTION WithoutURLPort(BYVAL value AS URL) AS URL

WithoutURLQuery

FUNCTION WithoutURLQuery(BYVAL value AS URL) AS URL

WithURLCredentials

FUNCTION WithURLCredentials(BYVAL value AS URL,username AS STRING) AS URL FAILS UrlError
FUNCTION WithURLCredentials(BYVAL value AS URL,username AS STRING,password AS STRING) AS URL FAILS UrlError

WithURLFragment

FUNCTION WithURLFragment(BYVAL value AS URL,fragment AS STRING) AS URL

WithURLHost

FUNCTION WithURLHost(BYVAL value AS URL,host AS STRING,port AS INTEGER=-1) AS URL FAILS UrlError

WithURLPath

FUNCTION WithURLPath(BYVAL value AS URL,path AS STRING) AS URL FAILS UrlError

WithURLPort

FUNCTION WithURLPort(BYVAL value AS URL,port AS INTEGER) AS URL FAILS UrlError

WithURLQuery

FUNCTION WithURLQuery(BYVAL value AS URL,parameters AS LIST OF URLParameter,form AS BOOLEAN=TRUE) AS URL FAILS UrlError
FUNCTION WithURLQuery(BYVAL value AS URL,parameters AS DICT OF STRING TO STRING) AS URL FAILS UrlError
FUNCTION WithURLQuery(BYVAL value AS URL,parameters AS DICT OF STRING TO LIST OF STRING) AS URL FAILS UrlError

WithURLScheme

FUNCTION WithURLScheme(BYVAL value AS URL,scheme AS STRING) AS URL FAILS UrlError

WithZoneSameInstant

FUNCTION WithZoneSameInstant(value AS ZonedDateTime,zone AS TimeZone) AS ZonedDateTime FAILS DateTimeError

WrappingAdd

FUNCTION WrappingAdd(left AS UINT64, right AS UINT64) AS UINT64

WrappingMultiply

FUNCTION WrappingMultiply(left AS UINT64, right AS UINT64) AS UINT64

WrappingSubtract

FUNCTION WrappingSubtract(left AS UINT64, right AS UINT64) AS UINT64

Write

FUNCTION Write[T](BYREF writer AS BufferedWriter[T],text AS STRING) AS INTEGER FAILS IoError WHERE T IS RESOURCE

WriteAll

FUNCTION WriteAll(text AS STRING) AS INTEGER FAILS IoError
FUNCTION WriteAll(bytes AS LIST OF INTEGER) AS INTEGER FAILS IoError
FUNCTION WriteAll(bytes AS LIST OF BYTE) AS INTEGER FAILS IoError

WriteAt

FUNCTION WriteAt(BYREF buffer AS ByteBuffer,offset AS INTEGER,bytes AS LIST OF BYTE) AS INTEGER FAILS IndexError

WriteByte

FUNCTION WriteByte(value AS INTEGER) AS INTEGER FAILS IoError
FUNCTION WriteByte(BYREF writer AS ByteWriter,value AS BYTE) AS INTEGER

WriteBytes

FUNCTION WriteBytes(BYREF writer AS ByteWriter,bytes AS LIST OF BYTE) AS INTEGER FAILS IndexError
FUNCTION WriteBytes[T](BYREF writer AS BufferedWriter[T],bytes AS LIST OF BYTE) AS INTEGER FAILS IoError,IndexError WHERE T IS RESOURCE

WriteDouble

FUNCTION WriteDouble(BYREF writer AS ByteWriter,value AS DOUBLE,Order AS ByteOrder=ByteOrder.LittleEndian) AS INTEGER

WriteFile

FUNCTION WriteFile(file AS File,text AS STRING) AS INTEGER FAILS IoError
FUNCTION WriteFile(file AS File,bytes AS LIST OF BYTE) AS INTEGER FAILS IoError

WriteFileAtomic

FUNCTION WriteFileAtomic(path AS STRING,text AS STRING,expected AS OPTIONAL OF FileInfo=NONE,expectAbsent AS BOOLEAN=FALSE) AS INTEGER FAILS IoError,FileChanged
FUNCTION WriteFileAtomic(path AS STRING,bytes AS LIST OF BYTE) AS INTEGER FAILS IoError

WriteHTTPBody

FUNCTION WriteHTTPBody(connection AS TCPConnection,BYREF exchange AS HTTPExchange,bytes AS LIST OF BYTE) AS INTEGER FAILS IoError,HTTPError,StringError
FUNCTION WriteHTTPBody(connection AS TCPConnection,BYREF exchange AS HTTPExchange,text AS STRING) AS INTEGER FAILS IoError,HTTPError,StringError

WriteHTTPResponse

FUNCTION WriteHTTPResponse(connection AS TCPConnection,BYREF exchange AS HTTPExchange,status AS INTEGER,headers AS LIST OF HTTPHeader,body AS LIST OF BYTE) AS INTEGER FAILS IoError,HTTPError,StringError
FUNCTION WriteHTTPResponse(connection AS TCPConnection,BYREF exchange AS HTTPExchange,status AS INTEGER,text AS STRING,contentType AS STRING="text/plain; charset=utf-8") AS INTEGER FAILS IoError,HTTPError,StringError
FUNCTION WriteHTTPResponse(connection AS TCPConnection,BYREF exchange AS HTTPExchange,response AS HTTPResponse) AS INTEGER FAILS IoError,HTTPError,StringError

WriteInt16

FUNCTION WriteInt16(BYREF writer AS ByteWriter,value AS INTEGER,Order AS ByteOrder=ByteOrder.LittleEndian) AS INTEGER FAILS NumericError

WriteInt32

FUNCTION WriteInt32(BYREF writer AS ByteWriter,value AS INTEGER,Order AS ByteOrder=ByteOrder.LittleEndian) AS INTEGER FAILS NumericError

WriteInt64

FUNCTION WriteInt64(BYREF writer AS ByteWriter,value AS INTEGER,Order AS ByteOrder=ByteOrder.LittleEndian) AS INTEGER

WriteInt8

FUNCTION WriteInt8(BYREF writer AS ByteWriter,value AS INTEGER) AS INTEGER FAILS NumericError

WriteJSON

FUNCTION WriteJSON[T](file AS File,value AS T,codec AS JsonCodec) AS INTEGER FAILS IoError,JsonError,LIKE codec, LIKE __JsonEncodeErrors(AS T)
FUNCTION WriteJSON[T](file AS File,value AS T) AS INTEGER FAILS IoError,JsonError,LIKE __JsonEncodeErrors(AS T)

WriteJSONFile

FUNCTION WriteJSONFile[T](path AS STRING,value AS T,codec AS JsonCodec) AS INTEGER FAILS IoError,JsonError,LIKE codec, LIKE __JsonEncodeErrors(AS T)
FUNCTION WriteJSONFile[T](path AS STRING,value AS T) AS INTEGER FAILS IoError,JsonError,LIKE __JsonEncodeErrors(AS T)

WriteJSONLine

FUNCTION WriteJSONLine[T](file AS File,value AS T,codec AS JsonCodec) AS INTEGER FAILS IoError,JsonError,LIKE codec, LIKE __JsonEncodeErrors(AS T)
FUNCTION WriteJSONLine[T](file AS File,value AS T) AS INTEGER FAILS IoError,JsonError,LIKE __JsonEncodeErrors(AS T)

WriteLine

FUNCTION WriteLine[T](BYREF writer AS BufferedWriter[T],text AS STRING="") AS INTEGER FAILS IoError WHERE T IS RESOURCE

WriteLog

SUB WriteLog(logger AS LoggerHandle,level AS LogLevel,message AS STRING,values AS LIST OF LogFieldValue) FAILS LoggingError
SUB WriteLog(logger AS Logger,level AS LogLevel,message AS STRING,values AS LIST OF LogFieldValue) FAILS LoggingError

WriteProcess

FUNCTION WriteProcess(process AS Process,text AS STRING) AS INTEGER FAILS IoError

WritePseudoTerminal

FUNCTION WritePseudoTerminal(terminal AS PseudoTerminal,text AS STRING) AS INTEGER FAILS IoError

WriteTCP

FUNCTION WriteTCP(connection AS TCPConnection,text AS STRING) AS INTEGER FAILS IoError
FUNCTION WriteTCP(connection AS TCPConnection,bytes AS LIST OF BYTE) AS INTEGER FAILS IoError
FUNCTION WriteTCP(connection AS TCPConnection,text AS STRING,timeout AS Duration) AS INTEGER FAILS IoError
FUNCTION WriteTCP(connection AS TCPConnection,bytes AS LIST OF BYTE,timeout AS Duration) AS INTEGER FAILS IoError

WriteTerminal

FUNCTION WriteTerminal(terminal AS Terminal,text AS STRING) AS INTEGER FAILS IoError

WriteUInt16

FUNCTION WriteUInt16(BYREF writer AS ByteWriter,value AS UINT32,Order AS ByteOrder=ByteOrder.LittleEndian) AS INTEGER FAILS NumericError

WriteUInt32

FUNCTION WriteUInt32(BYREF writer AS ByteWriter,value AS UINT32,Order AS ByteOrder=ByteOrder.LittleEndian) AS INTEGER

WriteUInt64

FUNCTION WriteUInt64(BYREF writer AS ByteWriter,value AS UINT64,Order AS ByteOrder=ByteOrder.LittleEndian) AS INTEGER

Find your way around BASIL

Type to search the manual.