Struct catalyzer::internals::crates::axum::extract::Extension

pub struct Extension<T>(pub T);

Expand description

Extractor and response for extensions.

§As extractor

This is commonly used to share state across handlers.

use axum::{
    Router,
    Extension,
    routing::get,
};
use std::sync::Arc;

// Some shared state used throughout our application
struct State {
    // ...
}

async fn handler(state: Extension<Arc<State>>) {
    // ...
}

let state = Arc::new(State { /* ... */ });

let app = Router::new().route("/", get(handler))
    // Add middleware that inserts the state into all incoming request's
    // extensions.
    .layer(Extension(state));

If the extension is missing it will reject the request with a 500 Internal Server Error response.

§As response

Response extensions can be used to share state with middleware.

use axum::{
    Extension,
    response::IntoResponse,
};

async fn handler() -> (Extension<Foo>, &'static str) {
    (
        Extension(Foo("foo")),
        "Hello, World!"
    )
}

#[derive(Clone)]
struct Foo(&'static str);

Tuple Fields§

§0: T

Trait Implementations§

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

fn clone(&self) -> Extension<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

impl<T> Debug for Extension<T>
where T: Debug,

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

Formats the value using the given formatter. Read more

impl<T> Default for Extension<T>
where T: Default,

fn default() -> Extension<T>

Returns the “default value” for a type. Read more

impl<T> Deref for Extension<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Extension<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for Extension<T>

fn deref_mut(&mut self) -> &mut <Extension<T> as Deref>::Target

Mutably dereferences the value.

impl<T, S> FromRequestParts<S> for Extension<T>
where T: Clone + Send + Sync + 'static, S: Send + Sync,

type Rejection = ExtensionRejection

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

fn from_request_parts<'life0, 'life1, 'async_trait>( req: &'life0 mut Parts, _state: &'life1 S ) -> Pin<Box<dyn Future<Output = Result<Extension<T>, <Extension<T> as FromRequestParts<S>>::Rejection>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Extension<T>: 'async_trait,

Perform the extraction.

impl<T> IntoResponse for Extension<T>
where T: Clone + Send + Sync + 'static,

fn into_response(self) -> Response<Body>

Create a response.

impl<T> IntoResponseParts for Extension<T>
where T: Clone + Send + Sync + 'static,

type Error = Infallible

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

fn into_response_parts( self, res: ResponseParts ) -> Result<ResponseParts, <Extension<T> as IntoResponseParts>::Error>

Set parts of the response

impl<S, T> Layer<S> for Extension<T>
where T: Clone + Send + Sync + 'static,

type Service = AddExtension<S, T>

The wrapped service

fn layer(&self, inner: S) -> <Extension<T> as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.

impl<T> Copy for Extension<T>
where T: Copy,

Auto Trait Implementations§

impl<T> Freeze for Extension<T>
where T: Freeze,

impl<T> RefUnwindSafe for Extension<T>
where T: RefUnwindSafe,

impl<T> Send for Extension<T>
where T: Send,

impl<T> Sync for Extension<T>
where T: Sync,

impl<T> Unpin for Extension<T>
where T: Unpin,

impl<T> UnwindSafe for Extension<T>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

type Future = Ready<Response<Body>>

The type of future calling this handler returns.

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

Call the handler with the given request.

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

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

Convert the handler into a Service by providing the state

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

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

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

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.

fn from_request<'life0, 'async_trait>( req: Request<Body>, state: &'life0 S ) -> Pin<Box<dyn Future<Output = Result<T, <T as FromRequest<S, ViaParts>>::Rejection>> + Send + 'async_trait>>
where 'life0: 'async_trait, T: 'async_trait,

Perform the extraction.

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

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

Convert the handler into a Service and no state.

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

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

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

Convert the handler into a MakeService which stores information about the incoming connection and has no state. Read more

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

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

impl<R> IntoRawResponse for R
where R: IntoResponse,