Struct pavex::kit::ApiKit

source ·
#[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>, }
Expand description

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)§

This struct is marked as 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>§query_params: Option<Constructor>§json_body: Option<Constructor>§url_encoded_body: Option<Constructor>§buffered_body: Option<Constructor>§body_size_limit: Option<Constructor>§server_request_id: Option<Constructor>

Implementations§

source§

impl ApiKit

source

pub fn new() -> Self

Create a new ApiKit with all the bundled constructors.

source

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§

source§

impl Clone for ApiKit

source§

fn clone(&self) -> ApiKit

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ApiKit

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for ApiKit

§

impl RefUnwindSafe for ApiKit

§

impl Send for ApiKit

§

impl Sync for ApiKit

§

impl Unpin for ApiKit

§

impl UnwindSafe for ApiKit

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more