Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Namespace Index

This index lists the public standard-library namespaces. Names that end in \_Private are not public and do not appear here.

Core values and contracts

NamespacePurpose
Whimthe VERSION constant
Whim\Attributeread attributes from symbols and members
Whim\Autoloadregister and run symbol autoloaders
Whim\Comparisonequality, order, and Ordering
Whim\Convertexplicit value conversion contracts
Whim\Defaultthe default-value contract
Whim\Enuminterfaces implemented by all enums
Whim\GCexplicit cycle collection
Whim\Markerbuilt-in attributes and compiler markers
Whim\OptionSome, None, and option helpers
Whim\Promisethe read-only async result contract
Whim\Referenceweak references and weak maps
Whim\Refinecommon aliases, ranges, and callable types
Whim\Reflectionread-only access to loaded declarations, types, and values
Whim\Reflection\Attributeattribute rules and target kinds
Whim\Reflection\Callablefunctions, methods, closures, captures, and bound arguments
Whim\Reflection\Generictype parameters, bindings, and type environments
Whim\Reflection\Membermethods, properties, constants, and enum cases
Whim\Reflection\Symbolclasses, interfaces, enums, aliases, newtypes, functions, and constants
Whim\Reflection\Typetype forms and their parts
Whim\ResultOk, Err, and throwable capture
Whim\Symbolsymbol lookup and symbol kinds
Whim\Typeengine-local type identifiers
Whim\Unwinderrors, exceptions, throwables, and trace frames

See Core Types and Functions, Reflection, Option and Result, and Built-in Attributes.

Strings, numbers, and collections

NamespacePurpose
Whim\Binaryfixed-width integer and float encoding
Whim\Dicteager keyed collection functions
Whim\Floatfloat parsing, bit forms, and checks
Whim\Intinteger parsing
Whim\Iterateiterators and lazy collection functions
Whim\Matharithmetic, statistics, bases, and math constants
Whim\Rangeruntime integer range objects
Whim\Strbyte-string search and changes
Whim\UnicodeUnicode case folding and code-point checks
Whim\Veceager list functions

See Strings, Numbers, and Binary Data, Collections and Data Structures, and Iterators.

Data structures and formats

NamespacePurpose
Whim\BSONBSON values, encoding, decoding, readers, and writers
Whim\CSVstreaming CSV readers and writers
Whim\Compressiongzip, deflate, Brotli, and Zstandard streams
Whim\DataStructurequeue, stack, deque, heap, and priority queue
Whim\Encodingshared encoding errors and contracts
Whim\Encoding\Base32Base32 text
Whim\Encoding\Base64standard and URL-safe Base64
Whim\Encoding\EncodedWordmail header encoded words
Whim\Encoding\Hexhexadecimal text
Whim\Encoding\PunycodePunycode labels
Whim\Encoding\QuotedPrintablequoted-printable text and bytes
Whim\Encoding\URIwhole-URI percent encoding
Whim\Encoding\UTF8UTF-8 checks and lossy repair
Whim\Encoding\Urlpercent and form encoding
Whim\HTMLWHATWG character references and escaping
Whim\JsonJSON values, encoding, and decoding
Whim\MIMEmedia types, fields, content IDs, and parts
Whim\MIME\MultiPartmultipart writing and parsing
Whim\MIME\Parttext, data, and raw MIME parts
Whim\MIME\Sniffmedia-type checks from byte prefixes
Whim\Regexbyte regular expressions
Whim\UUIDUUID parsing plus versions 4 and 7

See Encoding and Data Formats.

Time, environment, and the operating system

NamespacePurpose
Whim\Commandchild-process setup and control
Whim\DateTimedates, civil times, zones, and formatting
Whim\Envarguments, paths, and environment variables
Whim\OSowned file descriptors, accounts, and host metrics
Whim\PathPOSIX path constants
Whim\Processprocess identity, CPU time, signals, and executable lookup
Whim\ShellPOSIX shell quoting
Whim\Terminalterminal checks, paths, and size
Whim\Timedurations, monotonic instants, and wall time

See Time and Calendars and Environment, Processes, and Terminals.

Files and I/O

NamespacePurpose
Whim\Filetyped file handles and one-shot file work
Whim\Filesystempaths, directories, links, metadata, and disk space
Whim\IOhandle contracts, buffering, adapters, and copying

See Files and I/O.

Async work

NamespacePurpose
Whim\Asynctasks, futures, cancellation, groups, and limits
Whim\Channelbounded and unbounded task channels

See Tasks and Futures and Channels and Cancellation.

Network and addresses

NamespacePurpose
Whim\CIDRIP network blocks
Whim\IDNAinternational domain-name conversion
Whim\IPIPv4 and IPv6 values
Whim\IRIinternational resource identifiers
Whim\Networkendpoint, stream, listener, and connector contracts
Whim\SOCKSSOCKS5 proxy connections
Whim\TCPTCP streams, listeners, and connectors
Whim\TLSTLS settings, identities, streams, and listeners
Whim\UDPdatagram sockets
Whim\URIgeneric URI values and reference resolution
Whim\URLabsolute network URLs and origins
Whim\UnixUnix-domain streams, listeners, and pairs

See Network, TLS, and Proxies.

HTTP

NamespacePurpose
Whim\HTTP\ClientHTTP/1.1 and HTTP/2 clients and connectors
Whim\HTTP\Client\Middlewareclient cookie state and request policy
Whim\HTTP\Cookierequest cookies and Set-Cookie values
Whim\HTTP\Messagemethods, fields, requests, responses, and exchanges
Whim\HTTP\Message\Responsecommon response factories
Whim\HTTP\Routerroute registration and dispatch
Whim\HTTP\Serverserver setup, settings, and errors
Whim\HTTP\Server\Bindingstream-listener server bindings
Whim\HTTP\Server\Contextrequest context and optional capabilities
Whim\HTTP\Server\Handlerfunction, static-file, and handler contracts
Whim\HTTP\Server\MiddlewareCORS, sessions, compression, and timeouts
Whim\HTTP\Server\Responderbare and debug error responses
Whim\HTTP\Sessionsession values and settings
Whim\HTTP\Session\Storagememory and database session stores
Whim\HTTP\WebSocketWebSocket messages and connections
Whim\HTTP\WebSocket\Clientclient handshakes and connections
Whim\HTTP\WebSocket\Serverserver upgrades and connection handlers

See HTTP Messages and Cookies, HTTP Client, and HTTP Server.

Databases

NamespacePurpose
Whim\Databaseshared database, result, transaction, and pool contracts
Whim\Database\PostgreSQLevent-loop PostgreSQL driver
Whim\Database\SQLiteblocking-pool SQLite driver

See Databases.

Mail

NamespacePurpose
Whim\MessageInternet mail messages and IDs
Whim\Message\Addressmailboxes, groups, and address lists
Whim\SMTPSMTP values, envelopes, replies, and settings
Whim\SMTP\ClientSMTP transport and delivery reports
Whim\SMTP\Client\AuthenticationPLAIN, LOGIN, CRAM-MD5, SCRAM, and XOAUTH2

See Mail and MIME Messages.

Security and random data

NamespacePurpose
Whim\Hashdigests, HMAC, checksums, and streaming hashers
Whim\Passwordbcrypt and Argon2 password hashes
Whim\PseudoRandomthe process pseudo-random sequence
Whim\RandomSequencerepeatable and secure random sequence objects
Whim\SecureRandomoperating-system random bytes, strings, ints, and floats

See Hashes, Passwords, and Random Data.