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

E

FUNCTION E() AS DOUBLE

EdgeCanvas

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

ElapsedBetween

FUNCTION ElapsedBetween(start AS MonotonicInstant,finish AS MonotonicInstant) AS Duration FAILS DateTimeError
FUNCTION ElapsedBetween(start AS Instant,finish AS Instant) AS Duration FAILS DateTimeError

EmbossCanvas

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

EncodeAnimation

FUNCTION EncodeAnimation(animation AS Animation,format AS ImageFormat=ImageFormat.APNG,maxEncodedBytes AS INTEGER=67108864) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError,StringError

EncodeAPNG

FUNCTION EncodeAPNG(animation AS Animation,level AS INTEGER=6,maxEncodedBytes AS INTEGER=67108864) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError,StringError

EncodeBMP

FUNCTION EncodeBMP(canvas AS Canvas,maxEncodedBytes AS INTEGER=67108864) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError

EncodeGIF

FUNCTION EncodeGIF(canvas AS Canvas,quantize AS BOOLEAN=TRUE,maxEncodedBytes AS INTEGER=67108864) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError

EncodeGIFAnimation

FUNCTION EncodeGIFAnimation(animation AS Animation,quantize AS BOOLEAN=TRUE,maxEncodedBytes AS INTEGER=67108864) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError

EncodeImage

FUNCTION EncodeImage(canvas AS Canvas,format AS ImageFormat=ImageFormat.PNG) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError,StringError

EncodeJPEG

FUNCTION EncodeJPEG(canvas AS Canvas,quality AS INTEGER=90,grayscale AS BOOLEAN=FALSE,maxEncodedBytes AS INTEGER=67108864) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError

EncodeJPEGOnBackground

FUNCTION EncodeJPEGOnBackground(canvas AS Canvas,background AS Color,quality AS INTEGER=90,grayscale AS BOOLEAN=FALSE,maxEncodedBytes AS INTEGER=67108864) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError

EncodeJSON

FUNCTION EncodeJSON[T](value AS T,codec AS JsonCodec) AS STRING FAILS JsonError,LIKE codec, LIKE __JsonEncodeErrors(AS T)
FUNCTION EncodeJSON[T](value AS T) AS STRING FAILS JsonError,LIKE __JsonEncodeErrors(AS T)

EncodePNG

FUNCTION EncodePNG(canvas AS Canvas,level AS INTEGER=1,filter AS PNGFilter=PNGFilter.Adaptive,maxEncodedBytes AS INTEGER=67108864) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError,StringError

EncoderInfo

FUNCTION EncoderInfo(encoder AS TextEncoder) AS TextConversionInfo

EncodeText

FUNCTION EncodeText(text AS STRING,encoding AS TextEncoding,errors AS TextErrorPolicy=TextErrorPolicy.Strict,bom AS TextEncodeBom=TextEncodeBom.Omit,maxOutputBytes AS INTEGER=67108864) AS LIST OF BYTE FAILS TextEncodingError,IndexError,NumericError,StringError

EncodeTextChunk

FUNCTION EncodeTextChunk(BYREF encoder AS TextEncoder,text AS STRING,final AS BOOLEAN=FALSE) AS LIST OF BYTE FAILS TextEncodingError,IndexError,NumericError,StringError

EncodeTextWithInfo

FUNCTION EncodeTextWithInfo(text AS STRING,encoding AS TextEncoding,errors AS TextErrorPolicy=TextErrorPolicy.Strict,bom AS TextEncodeBom=TextEncodeBom.Omit,maxOutputBytes AS INTEGER=67108864) AS EncodedText FAILS TextEncodingError,IndexError,NumericError,StringError

EncodeURLComponent

FUNCTION EncodeURLComponent(text AS STRING) AS STRING FAILS StringError

EncodeUtf8

FUNCTION EncodeUtf8(text AS STRING) AS LIST OF BYTE

EncodeWebP

FUNCTION EncodeWebP(canvas AS Canvas,maxEncodedBytes AS INTEGER=67108864,maxWorkingBytes AS INTEGER=268435456) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError

EncodeWebPAnimation

FUNCTION EncodeWebPAnimation(animation AS Animation,maxEncodedBytes AS INTEGER=67108864,maxWorkingBytes AS INTEGER=268435456) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError

EncodeWebPLossless

FUNCTION EncodeWebPLossless(canvas AS Canvas,maxEncodedBytes AS INTEGER=67108864,maxWorkingBytes AS INTEGER=268435456) AS LIST OF BYTE FAILS CanvasError,IndexError,NumericError

EndOfMonth

FUNCTION EndOfMonth(value AS Date) AS Date FAILS DateTimeError

EndOfStream

FUNCTION EndOfStream[T](reader AS BufferedReader[T]) AS BOOLEAN WHERE T IS RESOURCE

EndOfYear

FUNCTION EndOfYear(value AS Date) AS Date FAILS DateTimeError

Endpoint

FUNCTION Endpoint[T](reader AS BufferedReader[T]) AS BORROW T FROM reader WHERE T IS RESOURCE
FUNCTION Endpoint[T](writer AS BufferedWriter[T]) AS BORROW T FROM writer WHERE T IS RESOURCE

ENDSWITH

FUNCTION ENDSWITH(text AS STRING, suffix AS STRING) AS BOOLEAN

Enqueue

SUB Enqueue[T](BYREF q AS Queue[T],BYVAL value AS T)

EnterTerminalScreen

FUNCTION EnterTerminalScreen(terminal AS Terminal) AS INTEGER FAILS IoError

EpochDays

FUNCTION EpochDays(value AS Date) AS INTEGER

Equal

FUNCTION Equal[T](left AS T, right AS T) AS BOOLEAN

ErrorKindName

FUNCTION ErrorKindName(kind AS DateTimeErrorKind) AS STRING

EscapeURLComponent

FUNCTION EscapeURLComponent(text AS STRING,form AS BOOLEAN=FALSE) AS STRING

EscapeURLPath

FUNCTION EscapeURLPath(text AS STRING) AS STRING

EuclideanMod

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

Exclude

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

EXP

FUNCTION EXP(value AS DOUBLE) AS DOUBLE

EXP2

FUNCTION EXP2(value AS DOUBLE) AS DOUBLE

EXPM1

FUNCTION EXPM1(value AS DOUBLE) AS DOUBLE

Extend

FUNCTION Extend[T](BYREF items AS LIST OF T, values AS LIST OF T) AS INTEGER
FUNCTION Extend(BYREF buffer AS ByteBuffer,bytes AS LIST OF BYTE) AS INTEGER FAILS IndexError
FUNCTION Extend(BYREF buffer AS ByteBuffer,bytes AS LIST OF BYTE,start AS INTEGER,count AS INTEGER) AS INTEGER FAILS IndexError

Extract

FUNCTION Extract[K,V](BYREF table AS DICT OF K TO V, key AS K) AS OPTIONAL OF V FAILS LIKE ValidateKey(AS K)
FUNCTION Extract[K,V](BYREF d AS SortedDictionary[K,V],key AS K) AS OPTIONAL OF V FAILS IndexError,LIKE __ValueOrderCheck(AS K),LIKE ValidateKey(AS K)
FUNCTION Extract[K,V](BYREF m AS MultiMap[K,V],key AS K) AS OPTIONAL OF LIST OF V FAILS LIKE ValidateKey(AS K)

ExtractAt

FUNCTION ExtractAt[T](BYREF items AS LIST OF T,index AS INTEGER) AS T FAILS IndexError
FUNCTION ExtractAt[K,V](BYREF m AS MultiMap[K,V],key AS K,index AS INTEGER) AS V FAILS MissingKey,IndexError,LIKE ValidateKey(AS K)

Find your way around BASIL

Type to search the manual.