Crate prest

source ·
Expand description

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

Re-exports

  • pub use axum;
  • pub use axum::http;
  • pub use tower;

Modules

  • env
    Inspection and manipulation of the process’s environment.
  • extract
    Types and traits for extracting data from requests.
  • header
    HTTP header types
  • sse
    Server-Sent Events (SSE) responses.
  • stream
    Asynchronous streams.

Macros

  • anyhow
    Construct an ad-hoc error from a string or existing non-anyhow error value.
  • bail
    Return early with an error.
  • debug
    Constructs an event at the debug level.
  • embed_as
    One-liner for structs with derived Embed
  • embed_build_output_as
    Shorthand to embed build artifacts like PWA assets and others
  • env
    Inspects an environment variable at compile time.
  • error
    Constructs an event at the error level.
  • html
    Compose HTML templates right inside of Rust code with ease.
  • info
    Constructs an event at the info level.
  • json
    Construct a serde_json::Value from a JSON literal.
  • state
  • trace
    Constructs an event at the trace level.
  • warn
    Constructs an event at the warn level.

Structs

  • AppendHeaders
    Append headers to a response.
  • Arc
    A thread-safe reference-counting pointer. ‘Arc’ stands for ‘Atomically Reference Counted’.
  • Body
    The body type used in axum requests and responses.
  • DefaultAssets
  • EmbeddedFile
    A file embedded into the binary
  • Error
    The Error type, a wrapper around a dynamic error type.
  • ErrorResponse
    An IntoResponse-based error type
  • Escaper
    Wrapper of a buffer that escapes HTML chars when it is written using fmt::Write
  • Extension
    Extractor and response for extensions.
  • Form
    URL encoded extractor and response.
  • 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.
  • HtmxLayer
    Layer that modifies non-HTMX requests with the provided Fn
  • 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.
  • NestedPath
    Access the path the matched the route is nested at.
  • Next
    The remainder of a middleware stack, including the handler.
  • OnceCell
    A thread-safe cell that can be written to only once.
  • 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.
  • Query
    Extractor that deserializes query strings into some type.
  • Redirect
    Response that redirects the request to another location.
  • ResponseParts
    Parts of a response.
  • Router
    The router type for composing handlers and services.
  • Runtime
    The Tokio runtime.
  • RuntimeBuilder
    Builds Tokio Runtime with custom configuration values.
  • RuntimeHandle
    Handle to the runtime.
  • RwLock
    An asynchronous reader-writer lock.
  • Scripts
    Renders into a bunch of <script> tags with builder-like interface
  • ServiceBuilder
    Declaratively construct Service values.
  • Sse
    An SSE response
  • 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 7230 et al.).
  • TcpListener
    A TCP socket server, listening for connections.
  • Uri
    The URI component of a request.
  • Uuid
    A Universally Unique Identifier (UUID).

Enums

Constants

Statics

Traits

  • Embed
    Derived trait for structs that embed files
  • Executable
  • FromRequest
    Types that can be created from requests.
  • FromRequestParts
    Types that can be created from request parts.
  • HostUtils
    Utility trait to use Router as the host
  • HtmxRouting
    Convenience trait to easily add HtmxLayer to the Router
  • HttpBody
    Trait representing a streaming body of a Request or Response.
  • IntoResponse
    Trait for generating responses.
  • IntoResponseParts
    Trait for adding headers and extensions to a response.
  • Layer
    Decorates a Service, transforming either the request or the response.
  • Render
    Trait that defines how something is rendered into HTML
  • Service
    An asynchronous function from a Request to a Response.
  • Stream
    A stream of values produced asynchronously.
  • StreamExt
    An extension trait for Streams that provides a variety of convenient combinator functions.
  • Table
  • TryStreamExt
    Adapters specific to Result-returning streams

Functions

  • any
    Route requests with the given handler regardless of the method.
  • block_in_place
    Runs the provided blocking function on the current thread without blocking the executor.
  • block_on
    Run a future to completion on the current thread.
  • check_dot_env
  • col
  • delete
    Route DELETE requests to the given handler.
  • from_extractor
    Create a middleware from an extractor.
  • from_extractor_with_state
    Create a middleware from an extractor with the given state.
  • from_fn
    Create a middleware from an async function.
  • from_fn_with_state
    Create a middleware from an async function with the given state.
  • get
    Route GET requests to the given handler.
  • is_pwa
  • 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
  • table
    Entry point function to build statement

Type Aliases

  • BoxError
    Alias for a type-erased error type.
  • Markup
    A block of markup is a string that does not need to be escaped.
  • MetaIter
  • Request
    Type alias for [http::Request] whose body type defaults to Body, the most common body type used with axum.
  • Response
    Type alias for [http::Response] whose body type defaults to Body, the most common body type used with axum.
  • Result
    Result<T, Error>
  • SseItem

Attribute Macros

Derive Macros

  • Embed
    Derive macro that embeds files and provides access to them through the given struct
  • Table