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

Back

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

BidiVisualOrder

FUNCTION BidiVisualOrder(levels AS LIST OF INTEGER) AS LIST OF INTEGER FAILS CanvasError,IndexError

BitAnd

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

BitCount

FUNCTION BitCount(value AS UINT64) AS INTEGER

BitDifference

FUNCTION BitDifference(left AS BitSet,right AS BitSet) AS BitSet FAILS CollectionError

BitIntersection

FUNCTION BitIntersection(left AS BitSet,right AS BitSet) AS BitSet FAILS CollectionError

BitNot

FUNCTION BitNot(value AS UINT64) AS UINT64

BitOr

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

BitSymmetricDifference

FUNCTION BitSymmetricDifference(left AS BitSet,right AS BitSet) AS BitSet FAILS CollectionError

BitUnion

FUNCTION BitUnion(left AS BitSet,right AS BitSet) AS BitSet FAILS CollectionError

BitXor

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

BooleanArgument

FUNCTION BooleanArgument(values AS DICT OF STRING TO ArgumentValue,name AS STRING) AS BOOLEAN FAILS ArgumentError

BooleanOption

FUNCTION BooleanOption(name AS STRING,Default AS BOOLEAN=FALSE,Short AS STRING="",Help AS STRING="",Global AS BOOLEAN=FALSE) AS CommandOption

BoxBlurCanvas

FUNCTION BoxBlurCanvas(canvas AS Canvas,radius AS INTEGER=1) AS Canvas FAILS CanvasError,IndexError,NumericError

BufferedBytes

FUNCTION BufferedBytes[T](reader AS BufferedReader[T]) AS INTEGER WHERE T IS RESOURCE
FUNCTION BufferedBytes[T](writer AS BufferedWriter[T]) AS INTEGER WHERE T IS RESOURCE

BufferedReader

FUNCTION BufferedReader[T](TAKE source AS T,Capacity AS INTEGER=8192) AS BufferedReader[T] FAILS IndexError WHERE T IS RESOURCE

BufferedWriter

FUNCTION BufferedWriter[T](TAKE destination AS T,Capacity AS INTEGER=8192) AS BufferedWriter[T] FAILS IndexError WHERE T IS RESOURCE

BufferSize

FUNCTION BufferSize[T](writer AS BufferedWriter[T]) AS INTEGER WHERE T IS RESOURCE

BuildURL

FUNCTION BuildURL(scheme AS STRING,host AS STRING,Query AS LIST OF URLParameter,path AS STRING="/",port AS INTEGER=-1) AS URL FAILS UrlError
FUNCTION BuildURL(scheme AS STRING,host AS STRING,Query AS DICT OF STRING TO STRING,path AS STRING="/",port AS INTEGER=-1) AS URL FAILS UrlError
FUNCTION BuildURL(scheme AS STRING,host AS STRING,Query AS DICT OF STRING TO LIST OF STRING,path AS STRING="/",port AS INTEGER=-1) AS URL FAILS UrlError
FUNCTION BuildURL(scheme AS STRING,host AS STRING,path AS STRING="/",port AS INTEGER=-1) AS URL FAILS UrlError

ByteBuffer

FUNCTION ByteBuffer(Capacity AS INTEGER=0) AS ByteBuffer FAILS IndexError
FUNCTION ByteBuffer(BYVAL bytes AS LIST OF BYTE) AS ByteBuffer

ByteCount

FUNCTION ByteCount(text AS STRING) AS INTEGER
FUNCTION ByteCount(builder AS StringBuilder) AS INTEGER

ByteReader

FUNCTION ByteReader(BYVAL bytes AS LIST OF BYTE) AS ByteReader
FUNCTION ByteReader(buffer AS ByteBuffer) AS ByteReader

Bytes

FUNCTION Bytes(buffer AS ByteBuffer) AS BORROW LIST OF BYTE FROM buffer
FUNCTION Bytes(writer AS ByteWriter) AS BORROW LIST OF BYTE FROM writer

BytesResponse

FUNCTION BytesResponse(bytes AS LIST OF BYTE,status AS INTEGER=200,contentType AS STRING="application/octet-stream") AS HTTPResponse

ByteWriter

FUNCTION ByteWriter(Capacity AS INTEGER=0) AS ByteWriter FAILS IndexError

Find your way around BASIL

Type to search the manual.