The Racket Reference🔗 i

1Language Model

1.1Evaluation Model

1.1.1Sub-expression Evaluation and Continuations

1.1.2Tail Position

1.1.3Multiple Return Values

1.1.4Top-Level Variables

1.1.5Objects and Imperative Update

1.1.6Garbage Collection

1.1.7Procedure Applications and Local Variables

1.1.8Variables and Locations

1.1.9Modules and Module-Level Variables

1.1.9.1Phases

1.1.9.2The Separate Compilation Guarantee

1.1.9.3Cross-Phase Persistent Modules

1.1.9.4Module Redeclarations

1.1.9.5Submodules

1.1.10Continuation Frames and Marks

1.1.11Prompts, Delimited Continuations, and Barriers

1.1.12Threads

1.1.13Parameters

1.1.14Exceptions

1.1.15Custodians

1.2Syntax Model

1.2.1Identifiers, Binding, and Scopes

1.2.2Syntax Objects

1.2.3Expansion (Parsing)

1.2.3.1Fully Expanded Programs

1.2.3.2Expansion Steps

1.2.3.3Expansion Context

1.2.3.4Introducing Bindings

1.2.3.5Transformer Bindings

1.2.3.6Local Binding Context

1.2.3.7Partial Expansion

1.2.3.8Internal Definitions

1.2.3.9Module Expansion, Phases, and Visits

1.2.3.10Macro-Introduced Bindings

1.2.4Compilation

1.2.5Namespaces

1.2.6Inferred Value Names

1.2.7Cross-Phase Persistent Module Declarations

1.3The Reader

1.4The Printer

1.5Implementations

2Notation for Documentation

2.1Notation for Module Documentation

2.2Notation for Syntactic Form Documentation

2.3Notation for Function Documentation

2.4Notation for Structure Type Documentation

2.5Notation for Parameter Documentation

2.6Notation for Other Documentation

3Syntactic Forms

3.1Modules: module, module*, ...

3.2Importing and Exporting: require and provide

3.2.1Additional require Forms

3.2.2Additional provide Forms

3.3Literals: quote and #%datum

3.4Expression Wrapper: #%expression

3.5Variable References and #%top

3.6Locations: #%variable-reference

3.7Procedure Applications and #%app

3.8Procedure Expressions: lambda and case-lambda

3.9Local Binding: let, let*, letrec, ...

3.10Local Definitions: local

3.11Constructing Graphs: shared

3.12Conditionals: if, cond, and, and or

3.13Dispatch: case

3.13.1Variants of case

3.14Definitions: define, define-syntax, ...

3.14.1require Macros

3.14.2provide Macros

3.15Sequencing: begin, begin0, and begin-for-syntax

3.16Guarded Evaluation: when and unless

3.17Assignment: set! and set!-values

3.18Iterations and Comprehensions: for, for/list, ...

3.18.1Iteration and Comprehension Forms

3.18.2Deriving New Iteration Forms

3.18.3Iteration Expansion

3.18.4Do Loops

3.19Continuation Marks: with-continuation-mark

3.20Quasiquoting: quasiquote, unquote, and unquote-splicing

3.21Syntax Quoting: quote-syntax

3.22Interaction Wrapper: #%top-interaction

3.23Blocks: block

3.24Internal-Definition Limiting: #%stratified-body

3.25Performance Hints: begin-encourage-inline

3.26Importing Modules Lazily: lazy-require

4Datatypes

4.1Equality

4.1.1Object Identity and Comparisons

4.1.2Equality and Hashing

4.1.3Implementing Equality for Custom Types

4.1.4Honest Custom Equality

4.1.5Combining Hash Codes

4.2Booleans

4.2.1Boolean Aliases

4.2.2Mutability Predicates

4.3Numbers

4.3.1Number Types

4.3.2Generic Numerics

4.3.2.1Arithmetic

4.3.2.2Number Comparison

4.3.2.3Powers and Roots

4.3.2.4Trigonometric Functions

4.3.2.5Complex Numbers

4.3.2.6Bitwise Operations

4.3.2.7Random Numbers

4.3.2.8Other Randomness Utilities

4.3.2.9Number–String Conversions

4.3.2.10Extra Constants and Functions

4.3.3Flonums

4.3.3.1Flonum Arithmetic

4.3.3.2Flonum Vectors

4.3.4Fixnums

4.3.4.1Fixnum Arithmetic

4.3.4.2Fixnum Vectors

4.3.4.3Fixnum Range

4.3.5Extflonums

4.3.5.1Extflonum Arithmetic

4.3.5.2Extflonum Constants

4.3.5.3Extflonum Vectors

4.3.5.4Extflonum Byte Strings

4.4Strings

4.4.1String Constructors, Selectors, and Mutators

4.4.2String Comparisons

4.4.3String Conversions

4.4.4Locale-Specific String Operations

4.4.5String Grapheme Clusters

4.4.6Additional String Functions

4.4.7Converting Values to Strings

4.5Byte Strings

4.5.1Byte String Constructors, Selectors, and Mutators

4.5.2Byte String Comparisons

4.5.3Bytes to/from Characters, Decoding and Encoding

4.5.4Bytes to Bytes Encoding Conversion

4.5.5Additional Byte String Functions

4.6Characters

4.6.1Characters and Scalar Values

4.6.2Character Comparisons

4.6.3Classifications

4.6.4Character Conversions

4.6.5Character Grapheme-Cluster Streaming

4.7Symbols

4.7.1Additional Symbol Functions

4.8Regular Expressions

4.8.1Regexp Syntax

4.8.2Additional Syntactic Constraints

4.8.3Regexp Constructors

4.8.4Regexp Matching

4.8.5Regexp Splitting

4.8.6Regexp Substitution

4.9Keywords

4.9.1Additional Keyword Functions

4.10Pairs and Lists

4.10.1Pair Constructors and Selectors

4.10.2List Operations

4.10.3List Iteration

4.10.4More List Iteration

4.10.5List Filtering

4.10.6List Searching

4.10.7Pair Accessor Shorthands

4.10.8Additional List Functions and Synonyms

4.10.9More List Grouping

4.10.10Immutable Cyclic Data

4.11Mutable Pairs and Lists

4.11.1Mutable Pair Constructors and Selectors

4.12Vectors

4.12.1Additional Vector Functions

4.13Stencil Vectors

4.14Boxes

4.15Hash Tables

4.15.1Additional Hash Table Functions

4.16Treelists

4.16.1Immutable Treelists

4.16.2Mutable Treelists

4.17Sequences and Streams

4.17.1Sequences

4.17.1.1Sequence Predicate and Constructors

4.17.1.2Sequence Conversion

4.17.1.3Additional Sequence Operations

4.17.1.3.1Additional Sequence Constructors and Functions

4.17.2Streams

4.17.3Generators

4.18Dictionaries

4.18.1Dictionary Predicates and Contracts

4.18.2Generic Dictionary Interface

4.18.2.1Primitive Dictionary Methods

4.18.2.2Derived Dictionary Methods

4.18.3Dictionary Sequences

4.18.4Contracted Dictionaries

4.18.5Custom Hash Tables

4.18.6Passing Keyword Arguments in Dictionaries

4.19Sets

4.19.1Hash Sets

4.19.2Set Predicates and Contracts

4.19.3Generic Set Interface

4.19.3.1Set Methods

4.19.4Custom Hash Sets

4.20Procedures

4.20.1Keywords and Arity

4.20.2Reflecting on Primitives

4.20.3Additional Higher-Order Functions

4.21Void

4.22Undefined

5Structures

5.1Defining Structure Types: struct

5.2Creating Structure Types

5.3Structure Type Properties

5.4Generic Interfaces

5.5Copying and Updating Structures

5.6Structure Utilities

5.6.1Additional Structure Utilities

5.7Structure Type Transformer Binding

6Classes and Objects

6.1Creating Interfaces

6.2Creating Classes

6.2.1Initialization Variables

6.2.2Fields

6.2.3Methods

6.2.3.1Method Definitions

6.2.3.2Inherited and Superclass Methods

6.2.3.3Internal and External Names

6.3Creating Objects

6.4Field and Method Access

6.4.1Methods

6.4.2Fields

6.4.3Generics

6.5Mixins

6.6Traits

6.7Object and Class Contracts

6.8Object Equality and Hashing

6.9Object Serialization

6.10Object Printing

6.11Object, Class, and Interface Utilities

6.12Surrogates

7Units

7.1Creating Units

7.2Invoking Units

7.3Linking Units and Creating Compound Units

7.4Inferred Linking

7.5Generating A Unit from Context

7.6Structural Matching

7.7Extending the Syntax of Signatures

7.8Unit Utilities

7.9Unit Contracts

7.10Single-Unit Modules

7.11Single-Signature Modules

7.12Transformer Helpers

8Contracts

8.1Data-structure Contracts

8.2Function Contracts

8.3Parametric Contracts

8.4Lazy Data-structure Contracts

8.5Structure Type Property Contracts

8.6Attaching Contracts to Values

8.6.1Nested Contract Boundaries

8.6.2Low-level Contract Boundaries

8.7Building New Contract Combinators

8.7.1Blame Objects

8.7.2Contracts as structs

8.7.3Obligation Information in Check Syntax

8.7.4Utilities for Building New Combinators

8.8Contract Utilities

8.9racket/contract/base

8.10Collapsible Contracts

8.11Legacy Contracts

8.12Random generation

9Pattern Matching

9.1Additional Matching Forms

9.2Extending match

9.3Library Extensions

10Control Flow

10.1Multiple Values

10.2Exceptions

10.2.1Error Message Conventions

10.2.2Raising Exceptions

10.2.3Handling Exceptions

10.2.4Configuring Default Handling

10.2.5Built-in Exception Types

10.2.6Additional Exception Functions

10.2.7Realms and Error Message Adjusters

10.3Delayed Evaluation

10.3.1Additional Promise Kinds

10.4Continuations

10.4.1Additional Control Operators

10.5Continuation Marks

10.6Breaks

10.7Exiting

10.8Unreachable Expressions

10.8.1Customized Unreachable Reporting

11Concurrency and Parallelism

11.1Threads

11.1.1Creating Threads

11.1.2Suspending, Resuming, and Killing Threads

11.1.3Synchronizing Thread State

11.1.4Thread Mailboxes

11.2Synchronization

11.2.1Events

11.2.2Channels

11.2.3Semaphores

11.2.4Buffered Asynchronous Channels

11.2.4.1Creating and Using Asynchronous Channels

11.2.4.2Contracts and Impersonators on Asynchronous Channels

11.3Thread-Local Storage

11.3.1Thread Cells

11.3.2Parameters

11.4Futures

11.4.1Creating and Touching Futures

11.4.2Future Semaphores

11.4.3Future Performance Logging

11.5Places

11.5.1Using Places

11.5.2Syntactic Support for Using Places

11.5.3Places Logging

11.6Engines

11.7Machine Memory Order

12Macros

12.1Pattern-Based Syntax Matching

12.2Syntax Object Content

12.2.1Syntax Object Source Locations

12.3Syntax Object Bindings

12.4Syntax Transformers

12.4.1require Transformers

12.4.2provide Transformers

12.4.3Keyword-Argument Conversion Introspection

12.4.4Portal Syntax Bindings

12.5Syntax Parameters

12.5.1Syntax Parameter Inspection

12.6Local Binding with Splicing Body

12.7Syntax Object Properties

12.8Syntax Taints

12.9Expanding Top-Level Forms

12.9.1Information on Expanded Modules

12.10Serializing Syntax

12.11File Inclusion

12.12Syntax Utilities

12.12.1Creating formatted identifiers

12.12.2Pattern variables

12.12.3Error reporting

12.12.4Recording disappeared uses

12.12.5Miscellaneous utilities

12.13Phase and Space Utilities

13Input and Output

13.1Ports

13.1.1Encodings and Locales

13.1.2Managing Ports

13.1.3Port Buffers and Positions

13.1.4Counting Positions, Lines, and Columns

13.1.5File Ports

13.1.6String Ports

13.1.7Pipes

13.1.8Structures as Ports

13.1.9Custom Ports

13.1.10More Port Constructors, Procedures, and Events

13.1.10.1Port String and List Conversions

13.1.10.2Creating Ports

13.1.10.3Port Events

13.1.10.4Copying Streams

13.2Byte and String Input

13.3Byte and String Output

13.4Reading

13.5Writing

13.6Pretty Printing

13.6.1Basic Pretty-Print Options

13.6.2Per-Symbol Special Printing

13.6.3Line-Output Hook

13.6.4Value Output Hook

13.6.5Additional Custom-Output Support

13.7Reader Extension

13.7.1Readtables

13.7.2Reader-Extension Procedures

13.7.3Special Comments

13.8Printer Extension

13.9Serialization

13.9.1Serialization Structures

13.10Fast-Load Serialization

13.11Cryptographic Hashing

14Reflection and Security

14.1Namespaces

14.2Evaluation and Compilation

14.3The racket/load Language

14.4Module Names and Loading

14.4.1Resolving Module Names

14.4.2Compiled Modules and References

14.4.3Dynamic Module Access

14.4.4Module Cache

14.5Impersonators and Chaperones

14.5.1Impersonator Constructors

14.5.2Chaperone Constructors

14.5.3Impersonator Properties

14.6Security Guards

14.7Custodians

14.8Thread Groups

14.9Structure Inspectors

14.10Code Inspectors

14.11Plumbers

14.12Sandboxed Evaluation

14.12.1Security Considerations

14.12.2Customizing Evaluators

14.12.3Interacting with Evaluators

14.12.4Miscellaneous

14.13The racket/repl Library

14.14Linklets and the Core Compiler

14.15Deprecation

14.15.1Deprecated Aliases

14.15.2Deprecated Alias Transformers

15Operating System

15.1Paths

15.1.1Manipulating Paths

15.1.2More Path Utilities

15.1.3Unix and Mac OS Paths

15.1.3.1Unix Path Representation

15.1.4Windows Paths

15.1.4.1Windows Path Representation

15.2Filesystem

15.2.1Locating Paths

15.2.2Files

15.2.3Directories

15.2.4Detecting Filesystem Changes

15.2.5Declaring Paths Needed at Run Time

15.2.6More File and Directory Utilities

15.3Networking

15.3.1TCP

15.3.2UDP

15.4Processes

15.4.1Simple Subprocesses

15.5Logging

15.5.1Creating Loggers

15.5.2Logging Events

15.5.3Receiving Logged Events

15.5.4Additional Logging Functions

15.6Time

15.6.1Date Utilities

15.7Environment Variables

15.8Environment and Runtime Information

15.9Command-Line Parsing

15.10Additional Operating System Functions

16Memory Management

16.1Weak Boxes

16.2Ephemerons

16.3Wills and Executors

16.4Garbage Collection

16.5Phantom Byte Strings

17Unsafe Operations

17.1Unsafe Numeric Operations

17.2Unsafe Character Operations

17.3Unsafe Compound-Data Operations

17.4Unsafe Extflonum Operations

17.5Unsafe Impersonators and Chaperones

17.6Unsafe Assertions

17.7Unsafe Undefined

18Running Racket

18.1Running Racket or GRacket

18.1.1Initialization

18.1.2Exit Status

18.1.3Init Libraries

18.1.4Command Line

18.1.5Language Run-Time Configuration

18.1.6Language Expand Configuration

18.2Libraries and Collections

18.2.1Collection Search Configuration

18.2.2Collection Links

18.2.3Collection Paths and Parameters

18.3Interactive Help

18.4Interaction Configuration

18.5Interactive Module Loading

18.5.1Entering Modules

18.5.2Loading and Reloading Modules

18.6Debugging

18.6.1Tracing

18.7Controlling and Inspecting Compilation

18.7.1Compilation Modes

18.7.1.1BC Compilation Modes

18.7.1.2CS Compilation Modes

18.7.2Inspecting Compiler Passes

18.8Kernel Forms and Functions

Bibliography

Index