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

PADLEFT

FUNCTION PADLEFT(text AS STRING, width AS INTEGER) AS STRING FAILS StringError

PADLEFTWITH

FUNCTION PADLEFTWITH(text AS STRING, width AS INTEGER, fill AS STRING) AS STRING FAILS StringError

PADRIGHT

FUNCTION PADRIGHT(text AS STRING, width AS INTEGER) AS STRING FAILS StringError

PADRIGHTWITH

FUNCTION PADRIGHTWITH(text AS STRING, width AS INTEGER, fill AS STRING) AS STRING FAILS StringError

ParseArguments

FUNCTION ParseArguments(root AS Command,arguments AS LIST OF STRING) AS ArgumentResult FAILS ArgumentError,StringError
FUNCTION ParseArguments(root AS Command) AS ArgumentResult FAILS ArgumentError,StringError,IoError
FUNCTION ParseArguments[T](defaults AS T,arguments AS LIST OF STRING) AS ArgumentResult FAILS ArgumentError,StringError
FUNCTION ParseArguments[T](defaults AS T) AS ArgumentResult FAILS ArgumentError,StringError,IoError

ParseDate

FUNCTION ParseDate(text AS STRING) AS Date FAILS DateTimeError
FUNCTION ParseDate(text AS STRING,options AS ParseOptions) AS Date FAILS DateTimeError

ParseDateTimeAmount

FUNCTION ParseDateTimeAmount(text AS STRING) AS DateTimeAmount FAILS DateTimeError

ParseDateWithPattern

FUNCTION ParseDateWithPattern(text AS STRING,pattern AS DateTimePattern) AS Date FAILS DateTimeError

ParseDuration

FUNCTION ParseDuration(text AS STRING) AS Duration FAILS DateTimeError

ParseFormatSpec

FUNCTION ParseFormatSpec(text AS STRING) AS FormatSpec

ParseHttpDate

FUNCTION ParseHttpDate(text AS STRING) AS Instant FAILS DateTimeError

ParseHTTPURL

FUNCTION ParseHTTPURL(text AS STRING) AS HTTPURL FAILS HTTPError,StringError
FUNCTION ParseHTTPURL(value AS URL) AS HTTPURL FAILS HTTPError,StringError

ParseInstant

FUNCTION ParseInstant(text AS STRING) AS Instant FAILS DateTimeError
FUNCTION ParseInstant(text AS STRING,options AS ParseOptions) AS Instant FAILS DateTimeError

ParseInstantWithPattern

FUNCTION ParseInstantWithPattern(text AS STRING,pattern AS DateTimePattern) AS Instant FAILS DateTimeError

ParseIPAddress

FUNCTION ParseIPAddress(host AS STRING) AS IPAddress FAILS IoError

ParseIsoWeekDate

FUNCTION ParseIsoWeekDate(text AS STRING) AS IsoWeekDate FAILS DateTimeError

ParseJSON

FUNCTION ParseJSON(text AS STRING,codec AS JsonCodec) AS JsonValue FAILS JsonError
FUNCTION ParseJSON(text AS STRING) AS JsonValue FAILS JsonError
FUNCTION ParseJSON(bytes AS LIST OF BYTE,codec AS JsonCodec) AS JsonValue FAILS JsonError
FUNCTION ParseJSON(bytes AS LIST OF BYTE) AS JsonValue FAILS JsonError

ParseJsonDocument

FUNCTION ParseJsonDocument(text AS STRING,codec AS JsonCodec) AS JsonDocument FAILS JsonError
FUNCTION ParseJsonDocument(text AS STRING) AS JsonDocument FAILS JsonError

ParseLocalDateTime

FUNCTION ParseLocalDateTime(text AS STRING) AS LocalDateTime FAILS DateTimeError
FUNCTION ParseLocalDateTime(text AS STRING,options AS ParseOptions) AS LocalDateTime FAILS DateTimeError

ParseLocalDateTimeWithPattern

FUNCTION ParseLocalDateTimeWithPattern(text AS STRING,pattern AS DateTimePattern) AS LocalDateTime FAILS DateTimeError

ParseLogPattern

FUNCTION ParseLogPattern(pattern AS STRING) AS LIST OF LogPatternPart FAILS LogFormatError

ParseMonthDay

FUNCTION ParseMonthDay(text AS STRING) AS MonthDay FAILS DateTimeError

ParseOffset

FUNCTION ParseOffset(text AS STRING) AS UtcOffset FAILS DateTimeError

ParseOffsetDateTime

FUNCTION ParseOffsetDateTime(text AS STRING) AS OffsetDateTime FAILS DateTimeError
FUNCTION ParseOffsetDateTime(text AS STRING,options AS ParseOptions) AS OffsetDateTime FAILS DateTimeError

ParseOffsetDateTimeWithPattern

FUNCTION ParseOffsetDateTimeWithPattern(text AS STRING,pattern AS DateTimePattern) AS OffsetDateTime FAILS DateTimeError

ParseOffsetTime

FUNCTION ParseOffsetTime(text AS STRING) AS OffsetTime FAILS DateTimeError

ParsePeriod

FUNCTION ParsePeriod(text AS STRING) AS Period FAILS DateTimeError

ParseRfc3339

FUNCTION ParseRfc3339(text AS STRING) AS ParsedTimestamp FAILS DateTimeError

ParseRfc9557

FUNCTION ParseRfc9557(text AS STRING,database AS ZoneDatabase,conflict AS OffsetConflictPolicy,options AS LocalResolveOptions) AS ParsedZonedTimestamp FAILS DateTimeError
FUNCTION ParseRfc9557(text AS STRING,database AS ZoneDatabase) AS ParsedZonedTimestamp FAILS DateTimeError

ParseTime

FUNCTION ParseTime(text AS STRING) AS TimeOfDay FAILS DateTimeError
FUNCTION ParseTime(text AS STRING,options AS ParseOptions) AS TimeOfDay FAILS DateTimeError

ParseTimeWithPattern

FUNCTION ParseTimeWithPattern(text AS STRING,pattern AS DateTimePattern) AS TimeOfDay FAILS DateTimeError

ParseURL

FUNCTION ParseURL(text AS STRING) AS URL FAILS UrlError

ParseURLQuery

FUNCTION ParseURLQuery(text AS STRING,form AS BOOLEAN=TRUE) AS LIST OF URLParameter FAILS UrlError

ParseUUID

FUNCTION ParseUUID(text AS STRING) AS UUID FAILS UuidError

ParseYearMonth

FUNCTION ParseYearMonth(text AS STRING) AS YearMonth FAILS DateTimeError

ParseZonedDateTime

FUNCTION ParseZonedDateTime(text AS STRING,database AS ZoneDatabase,conflict AS OffsetConflictPolicy,options AS LocalResolveOptions) AS ZonedDateTime FAILS DateTimeError
FUNCTION ParseZonedDateTime(text AS STRING,database AS ZoneDatabase) AS ZonedDateTime FAILS DateTimeError

Parts

FUNCTION Parts(value AS Date) AS DateParts

Peek

FUNCTION Peek[T](q AS PriorityQueue[T]) AS T FAILS EmptyCollection WHERE T IS COPYABLE
FUNCTION Peek[T](q AS PriorityQueue[T]) AS BORROW T FROM q FAILS EmptyCollection WHERE T IS RESOURCE

PeekPriority

FUNCTION PeekPriority[T](q AS PriorityQueue[T]) AS INTEGER FAILS EmptyCollection

PeerPort

FUNCTION PeerPort(socket AS TCPConnection) AS INTEGER FAILS IoError

PendingBytes

FUNCTION PendingBytes[T](writer AS BufferedWriter[T]) AS LIST OF BYTE FAILS IndexError WHERE T IS RESOURCE

PeriodDays

FUNCTION PeriodDays(value AS INTEGER) AS Period

PeriodDaysPart

FUNCTION PeriodDaysPart(value AS Period) AS INTEGER

PeriodFromStorageJSON

FUNCTION PeriodFromStorageJSON(value AS JsonValue) AS Period FAILS DateTimeError

PeriodMonths

FUNCTION PeriodMonths(value AS INTEGER) AS Period

PeriodMonthsPart

FUNCTION PeriodMonthsPart(value AS Period) AS INTEGER

PeriodToStorageJSON

FUNCTION PeriodToStorageJSON(value AS Period) AS JsonValue FAILS DateTimeError

PeriodWeeks

FUNCTION PeriodWeeks(value AS INTEGER) AS Period FAILS DateTimeError

PeriodYears

FUNCTION PeriodYears(value AS INTEGER) AS Period FAILS DateTimeError

PI

FUNCTION PI() AS DOUBLE

Pop

FUNCTION Pop[T](BYREF items AS LIST OF T) AS T FAILS EmptyCollection

PopBack

FUNCTION PopBack[T](BYREF q AS Deque[T]) AS T FAILS EmptyCollection
FUNCTION PopBack[T](BYREF q AS BoundedDeque[T]) AS T FAILS EmptyCollection

PopFront

FUNCTION PopFront[T](BYREF q AS Deque[T]) AS T FAILS EmptyCollection
FUNCTION PopFront[T](BYREF q AS BoundedDeque[T]) AS T FAILS EmptyCollection

PopPriority

FUNCTION PopPriority[T](BYREF q AS PriorityQueue[T]) AS T FAILS EmptyCollection

Position

FUNCTION Position(reader AS ByteReader) AS INTEGER

POW

FUNCTION POW(base AS DOUBLE, exponent AS DOUBLE) AS DOUBLE

PreviousTransition

FUNCTION PreviousTransition(value AS TimeZone,instant AS Instant) AS OPTIONAL OF ZoneTransition FAILS DateTimeError

PrintArgumentHelp

FUNCTION PrintArgumentHelp(help AS ArgumentHelp) AS INTEGER FAILS IoError

ProcessExited

FUNCTION ProcessExited(process AS Process) AS BOOLEAN FAILS IoError

PruneExpired

FUNCTION PruneExpired[K,V](BYREF cache AS Cache[K,V]) AS INTEGER FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K)

PruneExpiredAt

FUNCTION PruneExpiredAt[K,V](BYREF cache AS Cache[K,V],now AS MonotonicInstant) AS INTEGER FAILS CollectionError,DateTimeError,IoError,LIKE ValidateKey(AS K)

PseudoTerminalName

FUNCTION PseudoTerminalName(terminal AS PseudoTerminal) AS STRING FAILS IoError

Push

SUB Push[T](BYREF q AS PriorityQueue[T],priority AS INTEGER,BYVAL value AS T)

PushBack

SUB PushBack[T](BYREF q AS Deque[T],BYVAL value AS T)
FUNCTION PushBack[T](BYREF q AS BoundedDeque[T],BYVAL value AS T) AS OPTIONAL OF T FAILS EmptyCollection,CollectionError

PushFront

SUB PushFront[T](BYREF q AS Deque[T],BYVAL value AS T)
FUNCTION PushFront[T](BYREF q AS BoundedDeque[T],BYVAL value AS T) AS OPTIONAL OF T FAILS EmptyCollection,CollectionError

Put

FUNCTION Put[K,V](BYREF table AS DICT OF K TO V, key AS K, BYVAL value AS V) AS BOOLEAN FAILS LIKE ValidateKey(AS K)

Find your way around BASIL

Type to search the manual.