Struct ApiKit

#[non_exhaustive]
pub struct ApiKit {
    pub path_params: Option<Constructor>,
    pub query_params: Option<Constructor>,
    pub json_body: Option<Constructor>,
    pub url_encoded_body: Option<Constructor>,
    pub buffered_body: Option<Constructor>,
    pub body_size_limit: Option<Constructor>,
    pub server_request_id: Option<Constructor>,
}

A collection of first-party constructors that are often needed when building APIs.

Guide

Check out the “Kits” section of Pavex’s guide for a thorough introduction to kits and how to customize them.

Example

use pavex::blueprint::Blueprint;
use pavex::kit::ApiKit;
  
let mut bp = Blueprint::new();
let kit = ApiKit::new().register(&mut bp);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path_params: Option<Constructor>

The default constructor for PathParams.

query_params: Option<Constructor>

The default constructor for QueryParams.

json_body: Option<Constructor>

The default constructor for JsonBody.

url_encoded_body: Option<Constructor>

The default constructor for UrlEncodedBody.

buffered_body: Option<Constructor>

The default constructor for BufferedBody.

body_size_limit: Option<Constructor>

The default constructor for BodySizeLimit.

server_request_id: Option<Constructor>

The default constructor for ServerRequestId.

Implementations

impl ApiKit

pub fn new() -> Self

Create a new ApiKit with all the bundled constructors.

pub fn register(self, bp: &mut Blueprint) -> RegisteredApiKit

Register all the bundled constructors with a Blueprint.

Constructors that are set to None will not be registered.

Trait Implementations

impl Clone for ApiKit

fn clone(&self) -> ApiKit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiKit

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.