Trait tsukuyomi::endpoint::Endpoint

pub trait Endpoint<T> {
    type Output;
    type Error: Into<Error>;
    type Future: TryFuture<Ok = Self::Output, Error = Self::Error>;

    fn apply(
        &self,
        args: T,
        cx: &mut ApplyContext<'_, '_>
    ) -> ApplyResult<T, Self>;
    fn allowed_methods(&self) -> Option<AllowedMethods>;
}

A trait representing the process to be performed when a route matches.

Required Associated Types

type Output

type Error: Into<Error>

type Future: TryFuture<Ok = Self::Output, Error = Self::Error>

Required Methods

fn apply(&self, args: T, cx: &mut ApplyContext<'_, '_>) -> ApplyResult<T, Self>

Determines the Action that this endpoint performs based on the request method.

If the endpoint does not accept the incoming request method, it returns an Err.

fn allowed_methods(&self) -> Option<AllowedMethods>

Returns a list of HTTP methods that this endpoint accepts.

If it returns a None, it means that the endpoint accepts all methods.

This method is called when constructing a Handler and used for implementation of Handler::allowed_methods.

Implementations on Foreign Types

impl<E, T> Endpoint<T> for Rc<E>where
    E: Endpoint<T>,

type Output = <E as Endpoint<T>>::Output

type Error = <E as Endpoint<T>>::Error

type Future = <E as Endpoint<T>>::Future

fn apply(&self, args: T, cx: &mut ApplyContext<'_, '_>) -> ApplyResult<T, Self>

fn allowed_methods(&self) -> Option<AllowedMethods>

impl<E, T> Endpoint<T> for Arc<E>where
    E: Endpoint<T>,

type Output = <E as Endpoint<T>>::Output

type Error = <E as Endpoint<T>>::Error

type Future = <E as Endpoint<T>>::Future

fn apply(&self, args: T, cx: &mut ApplyContext<'_, '_>) -> ApplyResult<T, Self>

fn allowed_methods(&self) -> Option<AllowedMethods>

Implementors

impl<L, R, T> Endpoint<T> for Chain<L, R>where
    L: Endpoint<T>,
    R: Endpoint<T>,

type Output = Either<<L as Endpoint<T>>::Output, <R as Endpoint<T>>::Output>

type Error = Error

type Future = ChainFuture<<L as Endpoint<T>>::Future, <R as Endpoint<T>>::Future>