Trait finchers::endpoint::Endpoint

pub trait Endpoint<Bd>: IsEndpoint {
    type Output: Tuple;
    type Action: EndpointAction<Bd, Output = Self::Output>;
    fn action(&self) -> Self::Action;

    fn with_output<T: Tuple>(self) -> Self
    where
        Self: Endpoint<Bd, Output = T> + Sized,
    { ... }
}

Trait representing an endpoint, the main trait for abstracting HTTP services in Finchers.

The endpoint behaves as an asynchronous process that takes an HTTP request and convert it into a value of the associated type. The process that handles an request is abstracted by EndpointAction, and that instances are constructed by Endpoint for each request.

Associated Types

type Output: Tuple

The type of value that will be returned from Action.

type Action: EndpointAction<Bd, Output = Self::Output>

The type of EndpointAction associated with this endpoint.

Required Methods

fn action(&self) -> Self::Action

Spawns an instance of Action that applies to an request.

Provided Methods

fn with_output<T: Tuple>(self) -> Self where
    Self: Endpoint<Bd, Output = T> + Sized, 

Add an annotation that the associated type Output is fixed to T.

Implementations on Foreign Types

impl<'a, E, Bd> Endpoint<Bd> for &'a E where     E: Endpoint<Bd>,

type Output = E::Output

type Action = E::Action

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<E, Bd> Endpoint<Bd> for Box<E> where     E: Endpoint<Bd>,

type Output = E::Output

type Action = E::Action

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

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

type Output = E::Output

type Action = E::Action

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

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

type Output = E::Output

type Action = E::Action

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

Implementors

impl<Bd> Endpoint<Bd> for MatchEos

type Output = ()

type Action = Oneshot<MatchEosAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchSegment

type Output = ()

type Action = Oneshot<MatchSegmentAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchVerbConnect

type Output = ()

type Action = Oneshot<MatchVerbConnectAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchVerbDelete

type Output = ()

type Action = Oneshot<MatchVerbDeleteAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchVerbGet

type Output = ()

type Action = Oneshot<MatchVerbGetAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchVerbHead

type Output = ()

type Action = Oneshot<MatchVerbVerbAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchVerbOptions

type Output = ()

type Action = Oneshot<MatchVerbOptionsAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchVerbPatch

type Output = ()

type Action = Oneshot<MatchVerbPatchAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchVerbPost

type Output = ()

type Action = Oneshot<MatchVerbPostAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchVerbPut

type Output = ()

type Action = Oneshot<MatchVerbPutAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchVerbTrace

type Output = ()

type Action = Oneshot<MatchVerbTraceAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for MatchVerbs

type Output = ()

type Action = Oneshot<MatchVerbsAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for finchers::endpoints::body::Raw

type Output = (Bd,)

type Action = RawAction<Bd>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for ReceiveAll where     Bd: BufStream,     Bd::Error: Into<Box<dyn Error + Send + Sync + 'static>>,

type Output = (Vec<u8>,)

type Action = ReceiveAllAction<Bd>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for Text where     Bd: BufStream,     Bd::Error: Into<Box<dyn Error + Send + Sync + 'static>>,

type Output = (String,)

type Action = TextAction<Bd>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for Dir

type Output = (NamedFile,)

type Action = DirAction

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for File

type Output = (NamedFile,)

type Action = FileAction<Bd>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for finchers::endpoints::header::Raw

type Output = (Option<HeaderValue>,)

type Action = Oneshot<RawAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd> Endpoint<Bd> for finchers::endpoints::query::Raw

type Output = (Option<String>,)

type Action = Oneshot<RawAction>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd, T> Endpoint<Bd> for EndpointObj<Bd, T> where     T: Tuple,

type Output = T

type Action = EndpointActionObj<Bd, T>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<Bd, T> Endpoint<Bd> for LocalEndpointObj<Bd, T> where     T: Tuple,

type Output = T

type Action = LocalEndpointActionObj<Bd, T>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<E, F, Bd> Endpoint<Bd> for Map<E, F> where     E: Endpoint<Bd>,     F: Func<E::Output> + Clone,

type Output = (F::Out,)

type Action = MapAction<E::Action, F>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<E, F, Bd, R> Endpoint<Bd> for AndThen<E, F> where     E: Endpoint<Bd>,     F: Func<E::Output, Out = R> + Clone,     R: IntoFuture,     R::Error: Into<Error>,

type Output = (R::Item,)

type Action = AndThenAction<E::Action, R::Future, F>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<E, F, Bd, R> Endpoint<Bd> for MapErr<E, F> where     E: Endpoint<Bd>,     F: Fn(Error) -> R + Clone,     R: Into<Error>,

type Output = E::Output

type Action = MapErrAction<E::Action, F>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<E, F, Bd, R> Endpoint<Bd> for Recover<E, F> where     E: Endpoint<Bd, Output = (R::Item,)>,     F: Fn(Error) -> R + Clone,     R: IntoFuture,     R::Error: Into<Error>,

type Output = (R::Item,)

type Action = RecoverAction<E::Action, R::Future, F>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<E1, E2, Bd> Endpoint<Bd> for And<E1, E2> where     E1: Endpoint<Bd>,     E2: Endpoint<Bd>,     E1::Output: Combine<E2::Output>,

type Output = <E1::Output as Combine<E2::Output>>::Out

type Action = AndAction<Bd, E1::Action, E2::Action>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<E1, E2, Bd> Endpoint<Bd> for OrStrict<E1, E2> where     E1: Endpoint<Bd>,     E2: Endpoint<Bd, Output = E1::Output>,

type Output = E1::Output

type Action = OrStrictAction<E1::Action, E2::Action>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<E1, E2, T1, T2, Bd> Endpoint<Bd> for Or<E1, E2> where     E1: Endpoint<Bd, Output = (T1,)>,     E2: Endpoint<Bd, Output = (T2,)>,

type Output = (Either<T1, T2>,)

type Action = OrAction<E1::Action, E2::Action>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<T, Bd> Endpoint<Bd> for Param<T> where     T: FromEncodedStr,

type Output = (T,)

type Action = Oneshot<ParamAction<T>>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<T, Bd> Endpoint<Bd> for Path<T> where     T: ExtractPath,

type Output = T::Output

type Action = Oneshot<PathAction<T>>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<T, Bd> Endpoint<Bd> for Remains<T> where     T: FromEncodedStr,

type Output = (T,)

type Action = Oneshot<RemainsAction<T>>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<T, Bd> Endpoint<Bd> for Json<T> where     Bd: BufStream,     Bd::Error: Into<Box<dyn Error + Send + Sync + 'static>>,     T: DeserializeOwned,

type Output = (T,)

type Action = JsonAction<Bd, T>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<T, Bd> Endpoint<Bd> for Urlencoded<T> where     Bd: BufStream,     Bd::Error: Into<Box<dyn Error + Send + Sync + 'static>>,     T: DeserializeOwned,

type Output = (T,)

type Action = UrlencodedAction<Bd, T>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<T, Bd> Endpoint<Bd> for Matches<T> where     T: PartialEq<HeaderValue> + Clone,

type Output = ()

type Action = Oneshot<MatchesAction<T>>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<T, Bd> Endpoint<Bd> for finchers::endpoints::header::Optional<T> where     T: FromHeaderValue,

type Output = (Option<T>,)

type Action = Oneshot<OptionalAction<T>>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<T, Bd> Endpoint<Bd> for Parse<T> where     T: FromHeaderValue,

type Output = (T,)

type Action = Oneshot<ParseAction<T>>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<T, Bd> Endpoint<Bd> for finchers::endpoints::query::Optional<T> where     T: DeserializeOwned,

type Output = (Option<T>,)

type Action = Oneshot<OptionalAction<T>>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,

impl<T, Bd> Endpoint<Bd> for Required<T> where     T: DeserializeOwned,

type Output = (T,)

type Action = Oneshot<RequiredAction<T>>

fn action(&self) -> Self::Action

fn with_output<T: Tuple>(self) -> Self where     Self: Endpoint<Bd, Output = T> + Sized,