Module prelude 

Prelude module - import everything you need with use rustapi_rs::prelude::*

Macros

debug

Constructs an event at the debug level.

error

Constructs an event at the error level.

info

Constructs an event at the info level.

route

Helper macro to create a Route from a handler with RouteHandler trait

trace

Constructs an event at the trace level.

warn

Constructs an event at the warn level.

Structs

ApiError

Standard API error type

Body

Raw body bytes extractor

ClientIp

Client IP address extractor

Created

201 Created response wrapper

Extension

Extension extractor

HeaderValue

Single header value extractor

Headers

Headers extractor

Html

HTML response wrapper

Json

JSON body extractor

KeepAlive

Keep-alive configuration for SSE connections

Multipart

Multipart form data extractor

MultipartConfig

Configuration for multipart form handling

MultipartField

A single field from a multipart form

NoContent

204 No Content response

Path

Path parameter extractor

Query

Query string extractor

Redirect

Redirect response

Request

HTTP Request wrapper

RequestId

A unique identifier for a request

RequestIdLayer

Middleware layer that generates a unique request ID for each request

Route

Represents a route definition that can be registered with .mount()

Router

Main router

RustApi

Main application builder for RustAPI

RustApiConfig

Configuration builder for RustAPI with auto-routes

Sse

Server-Sent Events response wrapper

SseEvent

A Server-Sent Event

State

State extractor

StaticFile

Static file response

StaticFileConfig

Static file serving configuration

StatusCode

An HTTP status code (status-code in RFC 9110 et al.).

StreamBody

A streaming body wrapper for HTTP responses

TracingLayer

Middleware layer that creates tracing spans for requests

Typed

Typed path extractor

UploadedFile

File data wrapper for convenient access to uploaded files

ValidatedJson

Validated JSON body extractor

WithStatus

Generic wrapper for returning a response with a custom status code.

Traits

Deserialize

A data structure that can be deserialized from any data format supported by Serde.

IntoParams

Trait used to convert implementing type to OpenAPI parameters.

IntoResponse

Trait for types that can be converted into an HTTP response

Schema

Trait for implementing OpenAPI Schema object.

Serialize

A data structure that can be serialized into any data format supported by Serde.

TypedPath

Trait for defining typed paths

Validate

This is the original trait that was implemented by deriving Validate. It will still be implemented for struct validations that don’t take custom arguments. The call is being forwarded to the ValidateArgs<'v_a> trait.

Functions

delete

Create a DELETE route handler

delete_route

Create a DELETE route

get

Create a GET route handler

get_route

Create a GET route

patch

Create a PATCH route handler

patch_route

Create a PATCH route

post

Create a POST route handler

post_route

Create a POST route

put

Create a PUT route handler

put_route

Create a PUT route

serve_dir

Create a static file serving route

sse_response

Create an SSE response from a synchronous iterator of events

Type Aliases

Response

HTTP Response type

Result

Result type alias for RustAPI operations

Derive Macros

ApiError

Derive macro for implementing IntoResponse for error enums

Deserialize

IntoParams

Generate path parameters from struct’s fields.

Schema

Generate reusable OpenAPI schema to be used together with OpenApi.

Serialize

TypedPath

Derive macro for TypedPath

Validate