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

Has

FUNCTION Has[T](s AS SortedSet[T],value AS T) AS BOOLEAN FAILS LIKE __ValueOrderCheck(AS T),LIKE ValidateKey(AS T)
FUNCTION Has[K,V](d AS SortedDictionary[K,V],key AS K) AS BOOLEAN FAILS LIKE __ValueOrderCheck(AS K),LIKE ValidateKey(AS K)
FUNCTION Has[K,V](m AS MultiMap[K,V],key AS K) AS BOOLEAN FAILS LIKE ValidateKey(AS K)
FUNCTION Has(bits AS BitSet,index AS INTEGER) AS BOOLEAN FAILS IndexError

Hash

FUNCTION Hash[T](value AS T) AS INTEGER

HasURLQueryParameter

FUNCTION HasURLQueryParameter(parameters AS LIST OF URLParameter,name AS STRING) AS BOOLEAN
FUNCTION HasURLQueryParameter(value AS URL,name AS STRING) AS BOOLEAN FAILS UrlError
FUNCTION Header(name AS STRING,value AS STRING) AS HTTPHeader

HexDigest

FUNCTION HexDigest(bytes AS LIST OF BYTE) AS STRING FAILS StringError

Histogram

FUNCTION Histogram(canvas AS Canvas) AS ColorHistogram FAILS IndexError

HistogramRegion

FUNCTION HistogramRegion(canvas AS Canvas,region AS PixelRect) AS ColorHistogram FAILS CanvasError,IndexError

HitTestTextLayout

FUNCTION HitTestTextLayout(layout AS TextLayout,x AS DOUBLE,y AS DOUBLE) AS TextHit FAILS CanvasError,IndexError

Hour

FUNCTION Hour(value AS TimeOfDay) AS INTEGER

Hours

FUNCTION Hours(value AS INTEGER) AS Duration FAILS DateTimeError

HTTPClientOptions

FUNCTION HTTPClientOptions() AS HTTPClientOptions

HTTPContentType

FUNCTION HTTPContentType(path AS STRING) AS STRING FAILS StringError

HTTPDate

FUNCTION HTTPDate(seconds AS INTEGER) AS STRING FAILS StringError

HTTPExchange

FUNCTION HTTPExchange(options AS HTTPOptions) AS HTTPExchange
FUNCTION HTTPExchange() AS HTTPExchange

HTTPFallback

FUNCTION HTTPFallback(BYREF router AS HTTPRouter,handler AS CALLABLE(HTTPRequest,TCPConnection,BYREF HTTPExchange) FAILS (Error)) AS INTEGER

HTTPGet

FUNCTION HTTPGet(url AS STRING,options AS HTTPClientOptions) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError
FUNCTION HTTPGet(url AS STRING) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError
FUNCTION HTTPGet(url AS URL,options AS HTTPClientOptions) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError
FUNCTION HTTPGet(url AS URL) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError

HTTPGetJSON

FUNCTION HTTPGetJSON[T](url AS STRING,BYREF response AS HTTPResponse,codec AS JsonCodec,options AS HTTPClientOptions) AS OPTIONAL OF T FAILS IoError,HTTPError,TLSError,IndexError,StringError,HTTPStatusError,JsonError,LIKE codec, LIKE __JsonDecodeErrors(AS T)
FUNCTION HTTPGetJSON[T](url AS STRING,codec AS JsonCodec,options AS HTTPClientOptions) AS OPTIONAL OF T FAILS IoError,HTTPError,TLSError,IndexError,StringError,HTTPStatusError,JsonError,LIKE codec, LIKE __JsonDecodeErrors(AS T)
FUNCTION HTTPGetJSON[T](url AS STRING) AS OPTIONAL OF T FAILS IoError,HTTPError,TLSError,IndexError,StringError,HTTPStatusError,JsonError,LIKE __JsonDecodeErrors(AS T)

HTTPGetPlain

FUNCTION HTTPGetPlain(url AS STRING,options AS HTTPClientOptions) AS HTTPResponse FAILS IoError,HTTPError,IndexError,StringError
FUNCTION HTTPGetPlain(url AS STRING) AS HTTPResponse FAILS IoError,HTTPError,IndexError,StringError
FUNCTION HTTPGetPlain(url AS URL,options AS HTTPClientOptions) AS HTTPResponse FAILS IoError,HTTPError,IndexError,StringError
FUNCTION HTTPGetPlain(url AS URL) AS HTTPResponse FAILS IoError,HTTPError,IndexError,StringError

HTTPHeaderValue

FUNCTION HTTPHeaderValue(headers AS LIST OF HTTPHeader,name AS STRING) AS OPTIONAL OF STRING

HTTPOptions

FUNCTION HTTPOptions() AS HTTPOptions

HTTPPost

FUNCTION HTTPPost(url AS STRING,body AS LIST OF BYTE,contentType AS STRING,options AS HTTPClientOptions) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError
FUNCTION HTTPPost(url AS STRING,body AS LIST OF BYTE,contentType AS STRING) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError
FUNCTION HTTPPost(url AS STRING,text AS STRING,contentType AS STRING,options AS HTTPClientOptions) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError
FUNCTION HTTPPost(url AS STRING,text AS STRING,contentType AS STRING) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError
FUNCTION HTTPPost(url AS URL,body AS LIST OF BYTE,contentType AS STRING,options AS HTTPClientOptions) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError
FUNCTION HTTPPost(url AS URL,body AS LIST OF BYTE,contentType AS STRING) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError
FUNCTION HTTPPost(url AS URL,text AS STRING,contentType AS STRING,options AS HTTPClientOptions) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError
FUNCTION HTTPPost(url AS URL,text AS STRING,contentType AS STRING) AS HTTPResponse FAILS IoError,HTTPError,TLSError,IndexError,StringError

HTTPPostJSON

FUNCTION HTTPPostJSON[B,T](url AS STRING,body AS B,BYREF response AS HTTPResponse,codec AS JsonCodec,options AS HTTPClientOptions) AS OPTIONAL OF T FAILS IoError,HTTPError,TLSError,IndexError,StringError,HTTPStatusError,JsonError,LIKE codec, LIKE __JsonEncodeErrors(AS B), LIKE __JsonDecodeErrors(AS T)
FUNCTION HTTPPostJSON[B,T](url AS STRING,body AS B) AS OPTIONAL OF T FAILS IoError,HTTPError,TLSError,IndexError,StringError,HTTPStatusError,JsonError,LIKE __JsonEncodeErrors(AS B), LIKE __JsonDecodeErrors(AS T)

HTTPQueryValues

FUNCTION HTTPQueryValues(request AS HTTPRequest,name AS STRING) AS LIST OF STRING FAILS HTTPError,StringError

HTTPResponse

FUNCTION HTTPResponse() AS HTTPResponse

HTTPRouter

FUNCTION HTTPRouter() AS HTTPRouter

HYPOT

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

Find your way around BASIL

Type to search the manual.