Crate prest

Source
Expand description

These docs are focused on technical details. For tutorials check out prest.blog

Re-exports§

  • pub use result::AnyError;
  • pub use axum;
  • pub use axum::http;

Modules§

  • extract
    Types and traits for extracting data from requests.
  • header
    HTTP header types
  • sql
    re-export of GlueSQL core AST builder and other utils
  • stream
    Asynchronous streams.

Macros§

  • debug
    Constructs an event at the debug level.
  • e
    Shorthand to create formatted prest::Error values like e!("{x:?}")
  • embed_as
    One-liner for structs with derived Embed
  • embed_build_output_as
    Shorthand to embed build artifacts like PWA assets and others
  • error
    Constructs an event at the error level.
  • html
    Compose HTML templates right inside of Rust code with ease.
  • include_html
    Shorthand for `PreEscaped(include_str!(…))``
  • info
    Constructs an event at the info level.
  • json
    Construct a serde_json::Value from a JSON literal.
  • state
    Macro that simplifies lazy globals by reducing boilerplate, allowing ? operator and async init
  • trace
    Constructs an event at the trace level.
  • warn
    Constructs an event at the warn level.

Structs§

  • Arc
    A thread-safe reference-counting pointer. ‘Arc’ stands for ‘Atomically Reference Counted’.
  • Body
    The body type used in axum requests and responses.
  • Db
    Embedded database
  • ErrorResponse
    An IntoResponse-based error type
  • Extension
    Extractor and response for extensions.
  • HandleError
    A Service adapter that handles errors by converting them into responses.
  • HandleErrorLayer
    Layer that applies HandleError which is a Service adapter that handles errors by converting them into responses.
  • Head
    Renders into a <head> tag with builder-like interface
  • HeaderMap
    A set of HTTP headers
  • HeaderValue
    Represents an HTTP header field value.
  • Host
    Extractor that resolves the hostname of the request.
  • Html
    An HTML response.
  • JoinSet
    A collection of tasks spawned on a Tokio runtime.
  • Json
    JSON Extractor / Response.
  • Lazy
    A value which is initialized on the first access.
  • MatchedPath
    Access the path in the router that matches the request.
  • Method
    The Request Method (VERB)
  • Mutex
    An asynchronous Mutex-like type.
  • NaiveDate
    ISO 8601 calendar date without timezone. Allows for every proleptic Gregorian date from Jan 1, 262145 BCE to Dec 31, 262143 CE. Also supports the conversion from ISO 8601 ordinal and week date.
  • NaiveDateTime
    ISO 8601 combined date and time without timezone.
  • NaiveTime
    ISO 8601 time without timezone. Allows for the nanosecond precision and optional leap second representation.
  • NestedPath
    Access the path the matched the route is nested at.
  • Next
    The remainder of a middleware stack, including the handler.
  • OriginalUri
    Extractor that gets the original request URI regardless of nesting.
  • Path
    Extractor that will get captures from the URL and parse them using serde.
  • PreEscaped
    A wrapper that renders the inner value without escaping.
  • PrestRuntime
    Wrapper around tokio::runtime::Runtime that manages schedule and graceful shutdown
  • Redirect
    Response that redirects the request to another location.
  • Router
    The router type for composing handlers and services.
  • RwLock
    An asynchronous reader-writer lock.
  • ScheduledJobRecord
    Describes collected stats for scheduled jobs
  • Scripts
    Renders into a bunch of <script> tags with builder-like interface
  • Sse
    An SSE response
  • SseBroadcast
    Broadcasting singleton for SSE (check out todo sync example)
  • SseEvent
    Server-sent event
  • SseKeepAlive
    Configure the interval between keep-alive messages, the content of each message, and the associated stream.
  • StatusCode
    An HTTP status code (status-code in RFC 9110 et al.).
  • Uri
    The URI component of a request.
  • Utc
    The UTC time zone. This is the most efficient time zone when you don’t need the local time. It is also used as an offset (which is also a dummy type).
  • Uuid
    A Universally Unique Identifier (UUID).
  • Vals
    Utility that deserializes from either [Query] (GET) or Json (others) based on request method

Enums§

  • Error
    Error type used across prest codebase

Constants§

  • DOCTYPE
    Default doctype for HTML
  • OK
    Utility for type inference that allows using ? operator in closure handlers
  • REGISTER_SW_SNIPPET
    Default javascript code that registers a service worker from /sw.js

Statics§

Traits§

Functions§

  • any
    Route requests with the given handler regardless of the method.
  • await_blocking
  • block_in_place
    Runs the provided blocking function on the current thread without blocking the executor.
  • delete
    Route DELETE requests to the given handler.
  • env_var
    Fetches the environment variable key from the current process.
  • from_fn
    Create a middleware from an async function.
  • from_json_slice
    Deserialize an instance of type T from bytes of JSON text.
  • from_json_str
    Deserialize an instance of type T from a string of JSON text.
  • get
    Route GET requests to the given handler.
  • is_pwa
    Returns whether PWA will be built with current configs
  • join_all
    Creates a future which represents a collection of the outputs of the futures given.
  • ok
    Utility for type inference that allows using ? operator in closure handlers
  • patch
    Route PATCH requests to the given handler.
  • post
    Route POST requests to the given handler.
  • put
    Route PUT requests to the given handler.
  • route
    A little helper to init router and route in a single call to improve formatting
  • sleep
    Waits until duration has elapsed.
  • spawn
    Spawns a new asynchronous task, returning a JoinHandle for it.
  • timeout
    Requires a Future to complete before the specified duration has elapsed.
  • to_json_string
    Serialize the given data structure as a String of JSON.

Type Aliases§

Attribute Macros§

Derive Macros§

  • Deserialize
  • Embed
    Derive macro that embeds files and provides access to them through the given struct
  • Serialize
  • Table
    Generates schema and helper functions to use struct as a table in the embedded database