Struct axum::AddExtension

source · [−]

pub struct AddExtension<S, T> { /* private fields */ }

Expand description

Middleware for adding some shareable value to request extensions.

See Sharing state with handlers for more details.

Implementations

source

impl<S, T> AddExtension<S, T>

source

pub fn layer(value: T) -> AddExtensionLayer<T>

👎 Deprecated since 0.4.7:

Use axum::extract::Extension instead. It implements tower::Layer

Create a new AddExtensionLayer.

Trait Implementations

source

impl<S: Clone, T: Clone> Clone for AddExtension<S, T>

source

fn clone(&self) -> AddExtension<S, 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<S: Debug, T: Debug> Debug for AddExtension<S, T>

source

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

Formats the value using the given formatter. Read more

source

impl<ResBody, S, T> Service<Request<ResBody>> for AddExtension<S, T> where
S: Service<Request<ResBody>>,
T: Clone + Send + Sync + 'static,

type Response = S::Response

Responses given by the service.

type Error = S::Error

Errors produced by the service.

type Future = S::Future

The future response value.

source

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests. Read more

source

fn call(&mut self, req: Request<ResBody>) -> Self::Future

Process the request and return the response asynchronously. Read more

source

impl<S: Copy, T: Copy> Copy for AddExtension<S, T>

Auto Trait Implementations

impl<S, T> RefUnwindSafe for AddExtension<S, T> where
S: RefUnwindSafe,
T: RefUnwindSafe,

impl<S, T> Send for AddExtension<S, T> where
S: Send,
T: Send,

impl<S, T> Sync for AddExtension<S, T> where
S: Sync,
T: Sync,

impl<S, T> Unpin for AddExtension<S, T> where
S: Unpin,
T: Unpin,

impl<S, T> UnwindSafe for AddExtension<S, T> where
S: 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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 for T where
U: From<T>,

const: unstable · 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<M, S, Target, Request> MakeService<Target, Request> for M where
M: Service<Target, Response = S>,
S: Service<Request>,

type Response = <S as Service<Request>>::Response

Responses given by the service

type Error = <S as Service<Request>>::Error

Errors produced by the service

type Service = S

The Service value created by this factory

type MakeError = <M as Service<Target>>::Error

Errors produced while building a service.

type Future = <M as Service<Target>>::Future

The future of the Service instance.

source

fn poll_ready(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), <M as MakeService<Target, Request>>::MakeError>>

Returns Poll::Ready when the factory is able to create more services. Read more

source

fn make_service(
&mut self,
target: Target
) -> <M as MakeService<Target, Request>>::Future

Create and return a new service value asynchronously.

source

fn into_service(self) -> IntoService<Self, Request>

Consume this MakeService and convert it into a Service. Read more

source

fn as_service(&mut self) -> AsService<'_, Self, Request>

Convert this MakeService into a Service without consuming the original MakeService. Read more

source

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

source

fn and<P, B, E>(self, other: P) -> And<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

source

fn or<P, B, E>(self, other: P) -> Or<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, Request> ServiceExt<Request> for T where
T: Service<Request> + ?Sized,

source

fn ready(&mut self) -> Ready<'_, Self, Request>

Yields a mutable reference to the service when it is ready to accept a request.

source

fn ready_and(&mut self) -> Ready<'_, Self, Request>

👎 Deprecated since 0.4.6:

please use the ServiceExt::ready method instead

Yields a mutable reference to the service when it is ready to accept a request.

source

fn ready_oneshot(self) -> ReadyOneshot<Self, Request>

Yields the service when it is ready to accept a request.

source

fn oneshot(self, req: Request) -> Oneshot<Self, Request>

Consume this Service, calling with the providing request once it is ready.

source

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
S: Stream<Item = Request>,
Self::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,

Process all requests from the given Stream, and produce a Stream of their responses. Read more

source

fn and_then<F>(self, f: F) -> AndThen<Self, F> where
F: Clone,

Executes a new future after this service’s future resolves. This does not alter the behaviour of the poll_ready method. Read more

source

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
F: FnOnce(Self::Response) -> Response + Clone,

Maps this service’s response value to a different value. This does not alter the behaviour of the poll_ready method. Read more

source

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> Error + Clone,

Maps this service’s error value to a different value. This does not alter the behaviour of the poll_ready method. Read more

source

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

Maps this service’s result type (Result<Self::Response, Self::Error>) to a different value, regardless of whether the future succeeds or fails. Read more

source

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
F: FnMut(NewRequest) -> Request,

Composes a function in front of the service. Read more

source

fn filter<F, NewRequest>(self, filter: F) -> Filter<Self, F> where
F: Predicate<NewRequest>,

This is supported on crate feature filter only.

Composes this service with a Filter that conditionally accepts or rejects requests based on a predicate. Read more

source

fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F> where
F: AsyncPredicate<NewRequest>,

This is supported on crate feature filter only.

Composes this service with an AsyncFilter that conditionally accepts or rejects requests based on an [async predicate]. Read more

source

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
 Error: From<Self::Error>,
 F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
 Fut: Future<Output = Result<Response, Error>>,

Composes an asynchronous function after this service. Read more

source

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
 F: FnMut(Self::Future) -> Fut,
 Error: From<Self::Error>,
 Fut: Future<Output = Result<Response, Error>>,

Composes a function that transforms futures produced by the service. Read more

source

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error> where
 Self: 'static + Send,
 Self::Future: 'static,
 Self::Future: Send,

Convert the service into a Service + Send trait object. Read more

source

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error> where
 Self: 'static + Clone + Send,
 Self::Future: 'static,
 Self::Future: Send,

Convert the service into a Service + Clone + Send trait object. Read more

source

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

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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

Struct axum::AddExtension

Implementations

impl<S, T> AddExtension<S, T>

pub fn layer(value: T) -> AddExtensionLayer<T>

Trait Implementations

impl<S: Clone, T: Clone> Clone for AddExtension<S, T>

fn clone(&self) -> AddExtension<S, T>

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

impl<S: Debug, T: Debug> Debug for AddExtension<S, T>

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

impl<ResBody, S, T> Service<Request<ResBody>> for AddExtension<S, T> where S: Service<Request<ResBody>>, T: Clone + Send + Sync + 'static,

type Response = S::Response

type Error = S::Error

type Future = S::Future

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

fn call(&mut self, req: Request<ResBody>) -> Self::Future

impl<S: Copy, T: Copy> Copy for AddExtension<S, T>

Auto Trait Implementations

impl<S, T> RefUnwindSafe for AddExtension<S, T> where S: RefUnwindSafe, T: RefUnwindSafe,

impl<S, T> Send for AddExtension<S, T> where S: Send, T: Send,

impl<S, T> Sync for AddExtension<S, T> where S: Sync, T: Sync,

impl<S, T> Unpin for AddExtension<S, T> where S: Unpin, T: Unpin,

impl<S, T> UnwindSafe for AddExtension<S, T> where S: UnwindSafe, T: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<M, S, Target, Request> MakeService<Target, Request> for M where M: Service<Target, Response = S>, S: Service<Request>,

type Response = <S as Service<Request>>::Response

type Error = <S as Service<Request>>::Error

type Service = S

type MakeError = <M as Service<Target>>::Error

type Future = <M as Service<Target>>::Future

fn poll_ready( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), <M as MakeService<Target, Request>>::MakeError>>

fn make_service( &mut self, target: Target) -> <M as MakeService<Target, Request>>::Future

fn into_service(self) -> IntoService<Self, Request>

fn as_service(&mut self) -> AsService<'_, Self, Request>

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

fn and<P, B, E>(self, other: P) -> And<T, P> where T: Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P> where T: Policy<B, E>, P: Policy<B, E>,

impl<T> Same<T> for T

type Output = T

impl<T, Request> ServiceExt<Request> for T where T: Service<Request> + ?Sized,

fn ready(&mut self) -> Ready<'_, Self, Request>

fn ready_and(&mut self) -> Ready<'_, Self, Request>

fn ready_oneshot(self) -> ReadyOneshot<Self, Request>

fn oneshot(self, req: Request) -> Oneshot<Self, Request>

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where S: Stream<Item = Request>, Self::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,

fn and_then<F>(self, f: F) -> AndThen<Self, F> where F: Clone,

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where F: FnOnce(Self::Response) -> Response + Clone,

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where F: FnOnce(Self::Error) -> Error + Clone,

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where F: FnMut(NewRequest) -> Request,

fn filter<F, NewRequest>(self, filter: F) -> Filter<Self, F> where F: Predicate<NewRequest>,

fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F> where F: AsyncPredicate<NewRequest>,

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone, Fut: Future<Output = Result<Response, Error>>,

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where F: FnMut(Self::Future) -> Fut, Error: From<Self::Error>, Fut: Future<Output = Result<Response, Error>>,

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error> where Self: 'static + Send, Self::Future: 'static, Self::Future: Send,

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error> where Self: 'static + Clone + Send, Self::Future: 'static, Self::Future: Send,

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

impl<ResBody, S, T> Service<Request<ResBody>> for AddExtension<S, T> where
S: Service<Request<ResBody>>,
T: Clone + Send + Sync + 'static,

impl<S, T> RefUnwindSafe for AddExtension<S, T> where
S: RefUnwindSafe,
T: RefUnwindSafe,

impl<S, T> Send for AddExtension<S, T> where
S: Send,
T: Send,

impl<S, T> Sync for AddExtension<S, T> where
S: Sync,
T: Sync,

impl<S, T> Unpin for AddExtension<S, T> where
S: Unpin,
T: Unpin,

impl<S, T> UnwindSafe for AddExtension<S, T> where
S: UnwindSafe,
T: UnwindSafe,

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

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

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

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

impl<M, S, Target, Request> MakeService<Target, Request> for M where
M: Service<Target, Response = S>,
S: Service<Request>,

fn poll_ready(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), <M as MakeService<Target, Request>>::MakeError>>

fn make_service(
&mut self,
target: Target
) -> <M as MakeService<Target, Request>>::Future

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

fn and<P, B, E>(self, other: P) -> And<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

impl<T, Request> ServiceExt<Request> for T where
T: Service<Request> + ?Sized,

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
S: Stream<Item = Request>,
Self::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,

fn and_then<F>(self, f: F) -> AndThen<Self, F> where
F: Clone,

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
F: FnOnce(Self::Response) -> Response + Clone,

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> Error + Clone,

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
F: FnMut(NewRequest) -> Request,

fn filter<F, NewRequest>(self, filter: F) -> Filter<Self, F> where
F: Predicate<NewRequest>,

fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F> where
F: AsyncPredicate<NewRequest>,

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
Fut: Future<Output = Result<Response, Error>>,

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
F: FnMut(Self::Future) -> Fut,
Error: From<Self::Error>,
Fut: Future<Output = Result<Response, Error>>,

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error> where
Self: 'static + Send,
Self::Future: 'static,
Self::Future: Send,

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error> where
Self: 'static + Clone + Send,
Self::Future: 'static,
Self::Future: Send,

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

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

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

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

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