Crate pavex

Source
Expand description

§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§

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

Macros§

Structs§

  • 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.