rama_http::service::web

Struct WebService

Source 
pub struct WebService<State> { /* private fields */ }
Expand description

A basic web service that can be used to serve HTTP requests.

Note that this service boxes all the internal services, so it is not as efficient as it could be. For those locations where you need do not desire the convenience over performance, you can instead use a tuple of (M, S) tuples, where M is a matcher and S is a service, e.g. ((MethodMatcher::GET, service_a), (MethodMatcher::POST, service_b), service_fallback).

Implementations§

Source§

impl<State> WebService<State>
where State: Clone + Send + Sync + 'static,

Source

pub fn get<I, T>(self, path: &str, service: I) -> Self
where I: IntoEndpointService<State, T>,

add a GET route to the web service, using the given service.

Source

pub fn post<I, T>(self, path: &str, service: I) -> Self
where I: IntoEndpointService<State, T>,

add a POST route to the web service, using the given service.

Source

pub fn put<I, T>(self, path: &str, service: I) -> Self
where I: IntoEndpointService<State, T>,

add a PUT route to the web service, using the given service.

Source

pub fn delete<I, T>(self, path: &str, service: I) -> Self
where I: IntoEndpointService<State, T>,

add a DELETE route to the web service, using the given service.

Source

pub fn patch<I, T>(self, path: &str, service: I) -> Self
where I: IntoEndpointService<State, T>,

add a PATCH route to the web service, using the given service.

Source

pub fn head<I, T>(self, path: &str, service: I) -> Self
where I: IntoEndpointService<State, T>,

add a HEAD route to the web service, using the given service.

Source

pub fn options<I, T>(self, path: &str, service: I) -> Self
where I: IntoEndpointService<State, T>,

add a OPTIONS route to the web service, using the given service.

Source

pub fn trace<I, T>(self, path: &str, service: I) -> Self
where I: IntoEndpointService<State, T>,

add a TRACE route to the web service, using the given service.

Source

pub fn nest<I, T>(self, prefix: &str, service: I) -> Self
where I: IntoEndpointService<State, T>,

nest a web service under the given path.

The nested service will receive a request with the path prefix removed.

Source

pub fn dir(self, prefix: &str, dir: &str) -> Self

serve the given directory under the given path.

Source

pub fn on<I, T>(self, matcher: HttpMatcher<State, Body>, service: I) -> Self
where I: IntoEndpointService<State, T>,

add a route to the web service which matches the given matcher, using the given service.

Source

pub fn not_found<I, T>(self, service: I) -> Self
where I: IntoEndpointService<State, T>,

use the given service in case no match could be found.

Trait Implementations§

Source§

impl<State> Clone for WebService<State>

Source§

fn clone(&self) -> Self

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<State> Debug for WebService<State>

Source§

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

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

impl<State> Default for WebService<State>
where State: Clone + Send + Sync + 'static,

Source§

fn default() -> Self

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

impl<State> Service<State, Request<Body>> for WebService<State>
where State: Clone + Send + Sync + 'static,

Source§

type Response = Response<Body>

The type of response returned by the service.
Source§

type Error = Infallible

The type of error returned by the service.
Source§

async fn serve( &self, ctx: Context<State>, req: Request, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.
Source§

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

§

impl<State> Freeze for WebService<State>

§

impl<State> !RefUnwindSafe for WebService<State>

§

impl<State> Send for WebService<State>
where State: Send,

§

impl<State> Sync for WebService<State>
where State: Sync,

§

impl<State> Unpin for WebService<State>
where State: Unpin,

§

impl<State> !UnwindSafe for WebService<State>

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<State, S, Body> HttpClientExt<State> for S
where S: Service<State, Request<Body>, Response = Response<Body>>, <S as Service<State, Request<Body>>>::Error: Into<Box<dyn Error + Send + Sync>>,

Source§

type ExecuteResponse = Response<Body>

The response type returned by the execute method.
Source§

type ExecuteError = <S as Service<State, Request<Body>>>::Error

The error type returned by the execute method.
Source§

fn get( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a GET request to a URL. Read more
Source§

fn post( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a POST request to a URL. Read more
Source§

fn put( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a PUT request to a URL. Read more
Source§

fn patch( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a PATCH request to a URL. Read more
Source§

fn delete( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a DELETE request to a URL. Read more
Source§

fn head( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Convenience method to make a HEAD request to a URL. Read more
Source§

fn request( &self, method: Method, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>

Start building a Request with the Method and Url. Read more
Source§

fn execute( &self, ctx: Context<State>, request: Request<Body>, ) -> impl Future<Output = Result<<S as HttpClientExt<State>>::ExecuteResponse, <S as HttpClientExt<State>>::ExecuteError>>

Executes a Request. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<State, S, R> IntoEndpointService<State, (State, R)> for S
where State: Clone + Send + Sync + 'static, S: Service<State, Request<Body>, Response = R, Error = Infallible>, R: IntoResponse + Send + Sync + 'static,

Source§

fn into_endpoint_service( self, ) -> impl Service<State, Request<Body>, Response = Response<Body>, Error = Infallible>

convert the type into a rama_core::Service.
Source§

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

Source§

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

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

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

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

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