aide

Struct WithApi

Source 
pub struct WithApi<T>(pub T::Target, pub PhantomData<T>)
where
    T: ApiOverride;
Expand description

Allows non OperationInput or OperationOutput types to be used in aide handlers with a provided documentation.

For types that already implement OperationInput or OperationOutput it overrides the documentation with the provided one. See ApiOverride on how to implement such an override

Tuple Fields§

§0: T::Target§1: PhantomData<T>

Implementations§

Source§

impl<T> WithApi<T>
where T: ApiOverride,

Source

pub fn into_inner(self) -> T::Target

Unwraps Self into its inner type

Trait Implementations§

Source§

impl<T> AsMut<<T as ApiOverride>::Target> for WithApi<T>
where T: ApiOverride,

Source§

fn as_mut(&mut self) -> &mut T::Target

Converts this type into a mutable reference of the (usually inferred) input type.
Source§

impl<T> AsRef<<T as ApiOverride>::Target> for WithApi<T>
where T: ApiOverride,

Source§

fn as_ref(&self) -> &T::Target

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<T> Clone for WithApi<T>
where T: ApiOverride + Clone, T::Target: Clone,

Source§

fn clone(&self) -> WithApi<T>

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<T> Debug for WithApi<T>
where T: ApiOverride + Debug, T::Target: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Deref for WithApi<T>
where T: ApiOverride,

Source§

type Target = <T as ApiOverride>::Target

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<T> DerefMut for WithApi<T>
where T: ApiOverride,

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<'de, T> Deserialize<'de> for WithApi<T>
where T: ApiOverride, T::Target: Deserialize<'de>,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T, S> FromRequest<S> for WithApi<T>
where T: ApiOverride, T::Target: FromRequest<S>, S: Send + Sync,

Available on crate feature axum only.
Source§

type Rejection = <<T as ApiOverride>::Target as FromRequest<S>>::Rejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request( req: Request<Body>, state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl<T, S> FromRequestParts<S> for WithApi<T>
where T: ApiOverride, T::Target: FromRequestParts<S>, S: Send + Sync,

Available on crate feature axum only.
Source§

type Rejection = <<T as ApiOverride>::Target as FromRequestParts<S>>::Rejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.
Source§

impl<T> Hash for WithApi<T>
where T: ApiOverride + Hash, T::Target: Hash,

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T> IntoResponse for WithApi<T>
where T: ApiOverride, T::Target: IntoResponse,

Available on crate feature axum only.
Source§

fn into_response(self) -> Response

Create a response.
Source§

impl<T> IntoResponseParts for WithApi<T>
where T: ApiOverride, T::Target: IntoResponseParts,

Available on crate feature axum only.
Source§

type Error = <<T as ApiOverride>::Target as IntoResponseParts>::Error

The type returned in the event of an error. Read more
Source§

fn into_response_parts( self, res: ResponseParts, ) -> Result<ResponseParts, Self::Error>

Set parts of the response
Source§

impl<T> OperationInput for WithApi<T>
where T: OperationInput + ApiOverride,

Source§

fn operation_input(ctx: &mut GenContext, operation: &mut Operation)

Modify the operation. Read more
Source§

fn inferred_early_responses( ctx: &mut GenContext, operation: &mut Operation, ) -> Vec<(Option<u16>, Response)>

Inferred early responses are used to document early returns for extractors, guards inside handlers. For example these could represent JSON parsing errors, authentication failures. Read more
Source§

impl<T> OperationOutput for WithApi<T>
where T: OperationOutput + ApiOverride,

Source§

type Inner = <T as OperationOutput>::Inner

The type that is used in examples. Read more
Source§

fn operation_response( ctx: &mut GenContext, operation: &mut Operation, ) -> Option<Response>

Return a response documentation for this type, alternatively modify the operation if required. Read more
Source§

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation, ) -> Vec<(Option<u16>, Response)>

Inferred responses are used when the type is used as a request handler return type. Read more
Source§

impl<T> Ord for WithApi<T>
where T: ApiOverride + Ord, T::Target: Ord,

Source§

fn cmp(&self, other: &WithApi<T>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T> PartialEq for WithApi<T>
where T: ApiOverride + PartialEq, T::Target: PartialEq,

Source§

fn eq(&self, other: &WithApi<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T> PartialOrd for WithApi<T>
where T: ApiOverride + PartialOrd, T::Target: PartialOrd,

Source§

fn partial_cmp(&self, other: &WithApi<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T> Serialize for WithApi<T>
where T: ApiOverride, T::Target: Serialize,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<T> Copy for WithApi<T>
where T: ApiOverride + Copy, T::Target: Copy,

Source§

impl<T> Eq for WithApi<T>
where T: ApiOverride + Eq, T::Target: Eq,

Source§

impl<T> StructuralPartialEq for WithApi<T>
where T: ApiOverride,

Auto Trait Implementations§

§

impl<T> Freeze for WithApi<T>
where <T as ApiOverride>::Target: Freeze,

§

impl<T> RefUnwindSafe for WithApi<T>
where <T as ApiOverride>::Target: RefUnwindSafe, T: RefUnwindSafe,

§

impl<T> Send for WithApi<T>
where <T as ApiOverride>::Target: Send, T: Send,

§

impl<T> Sync for WithApi<T>
where <T as ApiOverride>::Target: Sync, T: Sync,

§

impl<T> Unpin for WithApi<T>
where <T as ApiOverride>::Target: Unpin, T: Unpin,

§

impl<T> UnwindSafe for WithApi<T>
where <T as ApiOverride>::Target: UnwindSafe, T: UnwindSafe,

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

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

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<S, T> FromRequest<S, ViaParts> for T
where S: Send + Sync, T: FromRequestParts<S>,

Source§

type Rejection = <T as FromRequestParts<S>>::Rejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.
Source§

async fn from_request( req: Request<Body>, state: &S, ) -> Result<T, <T as FromRequest<S, ViaParts>>::Rejection>

Perform the extraction.
Source§

impl<T, S> Handler<IntoResponseHandler, S> for T
where T: IntoResponse + Clone + Send + Sync + 'static,

Source§

type Future = Ready<Response<Body>>

The type of future calling this handler returns.
Source§

fn call( self, _req: Request<Body>, _state: S, ) -> <T as Handler<IntoResponseHandler, S>>::Future

Call the handler with the given request.
Source§

fn layer<L>(self, layer: L) -> Layered<L, Self, T, S>
where L: Layer<HandlerService<Self, T, S>> + Clone, <L as Layer<HandlerService<Self, T, S>>>::Service: Service<Request<Body>>,

Apply a tower::Layer to the handler. Read more
Source§

fn with_state(self, state: S) -> HandlerService<Self, T, S>

Convert the handler into a Service by providing the state
Source§

impl<H, T> HandlerWithoutStateExt<T> for H
where H: Handler<T, ()>,

Source§

fn into_service(self) -> HandlerService<H, T, ()>

Convert the handler into a Service and no state.
Source§

fn into_make_service(self) -> IntoMakeService<HandlerService<H, T, ()>>

Convert the handler into a MakeService and no state. Read more
Source§

fn into_make_service_with_connect_info<C>( self, ) -> IntoMakeServiceWithConnectInfo<HandlerService<H, T, ()>, C>

Available on crate feature tokio only.
Convert the handler into a MakeService which stores information about the incoming connection and has no state. Read more
Source§

impl<T> Instrument for T

Source§

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

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

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> IntoApi for T

Source§

fn into_api<A>(self) -> UseApi<T, A>

into UseApi
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Formattable for T
where T: Deref, <T as Deref>::Target: Formattable,

Source§

impl<T> IntoApiResponse for T
where T: IntoResponse + OperationOutput,

Source§

impl<T> Parsable for T
where T: Deref, <T as Deref>::Target: Parsable,