Crate pavex

Pavex - API reference

Welcome to the API reference for Pavex!

The API reference is fairly low-level.
If you want a high-level overview of Pavex, check out the documentation on Pavex’s website.
You’ll also find an installation guide as well as a quickstart tutorial to get you up and running with the framework in no time.

Modules

• blueprint
  Define the routes and the structure of your application using a Blueprint.
• connection
  Extract data concerning the HTTP connection.
• cookie
  Everything you need to work with HTTP cookies.
• error
  Error handling utilities.
• http
  Types related to the HTTP protocol (status codes, headers, etc).
• kit
  Convenient bundles of constructs for common use cases.
• middleware
  Middleware types and utilities.
• request
  Process and extract data from incoming HTTP requests.
• response
  Build HTTP responses, from scratch or by converting existing types.
• router
  Dispatch requests to the appropriate handler.
• serialization
  Serialization and deserialization utilities.
• server
  An HTTP Server and its supporting types, the toolkit you need to launch your Pavex application.
• telemetry
  Tools to instrument and troubleshoot your Pavex applications.
• time
  Utilities to work with dates, timestamps and datetimes.
• unit
  Type-safe wrappers for working with measurable quantities (e.g. bytes).

Macros

• f
  A macro to convert an unambiguous path into a RawCallable.

Structs

• Error
  Pavex’s error type: an opaque wrapper around the concrete error type return by your components (e.g. request handlers, constructors, etc.). It is used as an input parameter by error observers and universal error handlers.