StandardWebhook

axum_standardwebhooks

Struct StandardWebhook 

Source 
pub struct StandardWebhook<T>(pub T);
Expand description

An extractor that verifies a webhook request and extracts the inner payload.

StandardWebhook<T> wraps another extractor T and ensures that the webhook signature is valid before proceeding with the extraction of T. This provides a way to safely handle webhook payloads in Axum handlers.

The inner extractor T can be any type that implements FromRequest, such as [Json], [Form], or [Query].

Tuple Fields§

§0: T

Trait Implementations§

Source§

impl<T: Clone> Clone for StandardWebhook<T>

Source§

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

Returns a duplicate 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> Debug for StandardWebhook<T>

Source§

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

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

impl<T: Default> Default for StandardWebhook<T>

Source§

fn default() -> StandardWebhook<T>

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

impl<S, T> FromRequest<S> for StandardWebhook<T>
where T: FromRequest<S>, S: Send + Sync, SharedWebhook: FromRef<S>,

Source§

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

Extracts a StandardWebhook<T> from the request.

This method:

  1. Buffers the request body
  2. Verifies the webhook signature
  3. Extracts the inner type T from the request
§Errors

Returns an error if:

  • The request body could not be buffered
  • The webhook signature is invalid
  • The inner extractor T fails
Source§

type Rejection = StandardWebhookRejection<<T 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§

impl<T: Copy> Copy for StandardWebhook<T>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<T> UnwindSafe for StandardWebhook<T>
where 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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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<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> 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<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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,