Crate prest

source ·
Expand description

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

Re-exports§

Modules§

  • env
    Inspection and manipulation of the process’s environment.
  • extract
    Types and traits for extracting data from requests.
  • form
    Support for Form<T>
  • header
    HTTP header types
  • io
    Traits, helpers, and type definitions for asynchronous I/O functionality.
  • json
    Support for Json<T>
  • path
    Support for Path<T>
  • query
    Support for Query<T>
  • 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.
  • init
    Starting point for prest apps that performs basic setup
  • 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§

  • AnalyticsLayer
    Layer that modifies non-HTMX requests with the provided Fn
  • AppConfig
    Holds basic information about the app
  • AppendHeaders
    Append headers to a response.
  • Arc
    A thread-safe reference-counting pointer. ‘Arc’ stands for ‘Atomically Reference Counted’.
  • BaseDirs
    BaseDirs provides paths of user-invisible standard directories, following the conventions of the operating system the library is running on.
  • Body
    The body type used in axum requests and responses.
  • ColumnSchema
    Describes Table-derived column schema
  • DbSchema
    Describes a collection of Table-derived schemas
  • DefaultAssets
  • EmbeddedFile
    A file embedded into the binary
  • 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
  • HxBoosted
    The HX-Boosted header.
  • HxCurrentUrl
    The HX-Current-Url header.
  • HxEvent
    Represents a client-side event carrying optional data.
  • HxHistoryRestoreRequest
    The HX-History-Restore-Request header.
  • HxLocation
    The HX-Location header.
  • HxPrompt
    The HX-Prompt header.
  • HxPushUrl
    The HX-Push-Url header.
  • HxRedirect
    The HX-Redirect header.
  • HxRefresh
    The HX-Refreshheader.
  • HxReplaceUrl
    The HX-Replace-Url header.
  • HxRequest
    The HX-Request header.
  • HxReselect
    The HX-Reselect header.
  • HxResponseTrigger
    The HX-Trigger* header.
  • HxReswap
    The HX-Reswap header.
  • HxRetarget
    The HX-Retarget header.
  • HxTarget
    The HX-Target header.
  • HxTrigger
    The HX-Trigger header.
  • HxTriggerName
    The HX-Trigger-Name header.
  • 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.
  • PrestRuntime
  • ProjectDirs
    ProjectDirs computes the location of cache, config or data directories for a specific application, which are derived from the standard directories and the name of the project/organization.
  • Query
    Extractor that deserializes query strings into some type.
  • Redirect
    Response that redirects the request to another location.
  • ResponseParts
    Parts of a response.
  • RouteStats
    Describes collected stats for some path
  • 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.
  • Shutdown
    Interface for graceful shutdowns
  • 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.).
  • TableSchema
    Describes Table-derived table schema
  • Uri
    The URI component of a request.
  • UserDirs
    UserDirs provides paths of user-facing standard directories, following the conventions of the operating system the library is running on.
  • Uuid
    A Universally Unique Identifier (UUID).

Enums§

Constants§

Statics§

Traits§

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.
  • col
  • delete
    Route DELETE requests to the given handler.
  • dotenv
    Loads the .env file from the current directory or parents. This is typically what you want.
  • 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.
  • init_tracing_subscriber
    Initializes log collection
  • is_pwa
    Returns whether PWA will be built with current configs
  • 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
  • to_json_string
    Serialize the given data structure as a String of JSON.

Type Aliases§

Attribute Macros§

Derive Macros§

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